From 0516c09fec14d2b808192316ed7a7697371b092c Mon Sep 17 00:00:00 2001 From: DrMaxNix Date: Sat, 8 May 2021 20:10:05 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20description?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 831aa3c..bd57486 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,26 @@ # dns-watch -[dns-watch.org](https://www.dns-watch.org) watches how neutrally (mainly) german isps handle dns requests from their customers. +[dns-watch.org](https://www.dns-watch.org) is a service that allows you to see which (mainly German) Internet Service Providers try to censor internet access of their customers. + + + +## directory structure +- config/: config files for the backend behavior + - cache.php: lookup caching + - lookup.php: dns lookups + - nameserver.php: dns servers to use + +- functions/: basic callbacks for backend tasks + - lookup.php: dns lookups and caching + +- icon/: icons for ISPs and DNS providers + +- lookup/: page for lookup-api + - index.php: entry point for api + +- start/: start-page + - html/: compiled html + - src/: pug/sass source files + - feather.js: load feathericons + - index.css main stylesheet + - index.js main client scripts + - index.php entry point for start-page