git » debian:dnss » commit b5cd37e

README: Add a "quick start" section

author Alberto Bertogli
2016-11-08 13:42:17 UTC
committer Alberto Bertogli
2016-11-08 13:42:17 UTC
parent d16a3f585ef6e7d5333850ae8add080c40cc2c2b

README: Add a "quick start" section

README.md +24 -1

diff --git a/README.md b/README.md
index 1fe676a..4cbc71f 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,30 @@
 
 # dnss
 
-dnss is a tool for encapsulating DNS over more secure protocols.
+dnss is a tool for encapsulating DNS over more secure protocols, like HTTPS or
+GRPC.
+
+## Quick start
+
+If you want to set up dnss quickly, in DNS-over-HTTPS mode and using
+https://dns.google.com as a server, you can run the following:
+
+```
+# If you have Go installed but no environment prepared, do:
+mkdir /tmp/dnss; export GOPATH=/tmp/dnss; cd $GOPATH
+
+# Download and build the binary.
+go get blitiri.com.ar/go/dnss
+
+# Copy the binary to a system-wide location.
+sudo cp $GOPATH/bin/dnss /usr/local/bin
+
+# Set it up in systemd.
+sudo cp $GOPATH/src/blitiri.com.ar/go/dnss/etc/systemd/dns-to-https/* \
+	/etc/systemd/system/
+
+sudo systemctl dnss enable
+```
 
 
 ## DNS over HTTPS