git » dnss » commit 138d7e3

README: More miscellaneous updates

author Alberto Bertogli
2018-07-18 21:02:52 UTC
committer Alberto Bertogli
2018-07-18 21:22:31 UTC
parent b1919c9b6585d9fe68c63e7fe9504d1d9c322a90

README: More miscellaneous updates

README.md +24 -17

diff --git a/README.md b/README.md
index 99219c7..54ab4b8 100644
--- a/README.md
+++ b/README.md
@@ -3,21 +3,40 @@
 
 dnss is a daemon for using DNS over HTTPS.
 
-It can act as a "DNS to HTTPS" proxy (the most common use case), and as a "DNS
-over HTTPS" server in case you want end to end control.
+It can act as a proxy (the most common use case), and as a server (in case you
+want end to end control).
+
 
 [![Build Status](https://travis-ci.org/albertito/dnss.svg?branch=master)](https://travis-ci.org/albertito/dnss)
 [![Go Report Card](https://goreportcard.com/badge/github.com/albertito/dnss)](https://goreportcard.com/report/github.com/albertito/dnss)
 
 
+## Features
+
+* Supports the JSON-based protocol as implemented by
+  [dns.google.com](https://dns.google.com)
+  ([reference](https://developers.google.com/speed/public-dns/docs/dns-over-https)).
+* Supports the [DNS Queries over HTTPS
+  (DoH)](https://tools.ietf.org/html/draft-ietf-doh-dns-over-https) proposed
+  standard (and implemented by [Cloudflare's 1.1.1.1](https://1.1.1.1/)).
+* Local cache (optional).
+* HTTP(s) proxy support, autodetected from the environment.
+* Monitoring HTTP server, with exported variables and tracing to help
+  debugging.
+* Separate resolution for specific domains, useful for home networks with
+  local DNS servers.
+
+
 ## Install
 
 ### Debian/Ubuntu
 
-`$ apt install dnss`
+The `dnss` package installs the daemon configured in proxy mode and ready to
+use, using Google's public resolvers (and easily changed via configuration).
 
-That installs a dnss instance already configured in proxy mode and ready to
-go, using Google's public resolvers (and easily changed via configuration).
+```
+$ sudo apt install dnss
+```
 
 
 ### Manual install
@@ -38,15 +57,3 @@ sudo cp $GOPATH/src/blitiri.com.ar/go/dnss/etc/systemd/dns-to-https/* \
 
 sudo systemctl dnss enable
 ```
-
-## Supported protocols
-
-dnss supports the following encapsulation protocols, both in proxy and in
-server modes:
-
-* JSON-based, as implemented by [dns.google.com](https://dns.google.com)
-  ([reference](https://developers.google.com/speed/public-dns/docs/dns-over-https)).
-* [DNS Queries over HTTPS
-  (DoH)](https://tools.ietf.org/html/draft-ietf-doh-dns-over-https) proposed
-  standard (and implemented by [Cloudflare's 1.1.1.1](https://1.1.1.1/)).
-