From 6b0e2322ed828863cebe4ee042bac123af418208 Mon Sep 17 00:00:00 2001 From: John M Date: Wed, 30 Dec 2020 21:41:59 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/README.md => README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) rename .github/README.md => README.md (68%) diff --git a/.github/README.md b/README.md similarity index 68% rename from .github/README.md rename to README.md index c3e6af0..d551d20 100644 --- a/.github/README.md +++ b/README.md @@ -1,6 +1,8 @@ -# dns.zt +# ZeroDNS -`dns.zt` is a CoreDNS-based Docker container that allows for name resolution of your [ZeroTier][zt] peers. You should point your local machine's DNS to localhost (127.0.0.1) to enable this mapping. +![Latest ZeroDNS Release](https://github.com/ionlights/zerodns/workflows/Compile%20Release%20into%20Container/badge.svg) + +`ZeroDNS` is a CoreDNS-based Docker container that allows for name resolution of your [ZeroTier][zt] peers. You should point your local machine's DNS to localhost (127.0.0.1) to enable this mapping. ## Usage @@ -16,7 +18,7 @@ dnses: ["1.1.1.1", "1.0.0.1", ] # the default DNS, provided by Cloudflare A likely setup would be as follows: ``` -ztdns +zerodns ├── config.yml # This configuration file should be manually added ├── Corefile # This is automatically generated by DNS.zt └── zt.hosts # This is automatically generated by DNS.zt @@ -30,9 +32,9 @@ ztdns **NOTE:** _Don't store this in a publicly accessible folder/repository_. It gives wide-ranging privileges to your ZeroTier account. -### Why does DNS.zt need my `access_token`? +### Why does `ZeroDNS` need my `access_token`? -We use your `access_token` to query your ZeroTier networks by name. The entire "API" is read-only, and you can validate that by looking at [tasks/ztapi.py](root/app/tasks/ztapi.py). +We use your `access_token` to query your ZeroTier networks by ID or Name. The entire "API" is read-only, and you can validate that by looking at [tasks/ztapi.py](root/app/tasks/ztapi.py). ## Current limitations