all: imp imgs, docs

.github/ISSUE_TEMPLATE/bug.yml

@@ -86,7 +86,7 @@
             description of the failing action:
 
             ```sh
-            nslookup -debug -type=a "www.example.com" "$YOUR_AGH_ADDRESS:"
+            nslookup -debug -type=a "www.example.com" "${AGDNS_CLIENT_ADDRESS}"
             ```
     'id': 'failing_action'
     'type': 'textarea'

CONTRIBUTING.md

@@ -6,16 +6,13 @@ If you want to contribute to AdGuard DNS Client by filing or commenting on an is
 
 Please don’t:
 
-- post comments like “+1” or “this”. Use the :+1: reaction on the issue instead, as this allows us to actually see the level of support for issues.
-
-- file issues about a particular filtering-rule list misbehaving. These are tracked through the [separate form for filtering issues][form].
-
+- post comments like “+1” or “this”. Use the :+1: reaction on the issue instead, as this allows us to actually see the level of support for issues;
+- file issues about a particular filtering-rule list misbehaving. These are tracked through the [separate form for filtering issues][form];
 - send or request updates to filtering-rule lists, such as the ones for the Blocked Services feature or the list of approved filtering-rule lists. We update them from the [separate repository][hostlist] once before each Beta and Release build.
 
 Please do:
 
-- follow the template instructions and provide data for reproducing issues.
-
+- follow the template instructions and provide data for reproducing issues;
 - write the title of your issue or pull request in English. Any language is fine in the body, but it is important to keep the title in English to make it easier for people and bots to look up duplicated issues.
 
 [form]:     https://reports.adguard.com/en/new_issue.html

Makefile

@@ -21,6 +21,7 @@ GO.MACRO = $${GO:-go}
 VERBOSE.MACRO = $${VERBOSE:-0}
 
 BRANCH = $$( git rev-parse --abbrev-ref HEAD )
+CHANNEL = development
 REVISION = $$( git rev-parse --short HEAD )
 DIST_DIR = dist
 GOAMD64 = v1
@@ -36,19 +37,20 @@ VERSION = v0.0.0
 
 ENV = env\
 	BRANCH="$(BRANCH)"\
-	REVISION="$(REVISION)"\
+	CHANNEL="$(CHANNEL)"\
+	DEPLOY_SCRIPT_PATH='$(DEPLOY_SCRIPT_PATH)' \
 	DIST_DIR='$(DIST_DIR)'\
 	GO="$(GO.MACRO)"\
 	GOAMD64='$(GOAMD64)'\
 	GOPROXY='$(GOPROXY)'\
 	GOTOOLCHAIN='$(GOTOOLCHAIN)'\
 	GPG_KEY='$(GPG_KEY)'\
 	GPG_KEY_PASSPHRASE='$(GPG_KEY_PASSPHRASE)'\
-	DEPLOY_SCRIPT_PATH='$(DEPLOY_SCRIPT_PATH)' \
-	SIGNER_API_KEY='$(SIGNER_API_KEY)' \
 	PATH="$${PWD}/bin:$$( "$(GO.MACRO)" env GOPATH )/bin:$${PATH}"\
 	RACE='$(RACE)'\
+	REVISION="$(REVISION)"\
 	SIGN='$(SIGN)'\
+	SIGNER_API_KEY='$(SIGNER_API_KEY)' \
 	VERBOSE="$(VERBOSE.MACRO)"\
 	VERSION="$(VERSION)"\
 

README.md

@@ -3,15 +3,12 @@
 <div align="center">
     <picture>
         <source media="(prefers-color-scheme: dark)" srcset="https://cdn.adtidy.org/website/images/AdGuardDNS_light.svg">
-        <img alt="AdGuard DNS" src="https://cdn.adtidy.org/website/images/AdGuardDNS_black.svg" width="300px"/>
+        <img alt="AdGuard DNS Logo" src="https://cdn.adtidy.org/website/images/AdGuardDNS_black.svg" width="300px"/>
     </picture>
 </div>
 
-<!--
-    TODO(a.garipov): !! Add screenshot to the CDN.
--->
 <p align="center">
-    <img src="https://cdn.adtidy.org/public/Adguard/Common/adguard_dns_client.png" width="800"/>
+    <img alt="Screenshot showing the logs of AdGuard DNS Client" src="https://cdn.adtidy.org/content/illustrations/adguard_dns_client.png" width="800"/>
 </p>
 
 A cross-platform lightweight DNS client for [AdGuard DNS]. It operates as a DNS server that forwards DNS requests to the corresponding upstream resolvers.
@@ -23,13 +20,13 @@ A cross-platform lightweight DNS client for [AdGuard DNS]. It operates as a DNS
 > [!NOTE]
 > AdGuard DNS Client is still in the Beta stage. Things will break and there are still bugs.
 
-Supported platforms:
+Supported operating systems:
 
-- macOS;
 - Linux;
+- macOS;
 - Windows.
 
-Supported architectures:
+Supported CPU architectures:
 
 - 64-bit ARM;
 - AMD64;
@@ -81,7 +78,7 @@ See [`CONTRIBUTING.md`][contr] for more details on how to contribute.
 
 ### <a href="#dev-start" id="dev-start" name="dev-start">Development quick start</a>
 
-You'll need Go 1.22 or later. First, register our pre-commit hooks:
+You will need Go 1.22 or later. First, register our pre-commit hooks:
 
 ```sh
 make init
@@ -93,7 +90,7 @@ Then, install the necessary tools and dependencies:
 make go-deps go-tools
 ```
 
-That's pretty much it! You should now be able to lint, test, and build the `AdGuardDNSClient` binary:
+That’s pretty much it! You should now be able to lint, test, and build the `AdGuardDNSClient` binary:
 
 ```sh
 make go-lint
@@ -124,10 +121,13 @@ Option `-v` enables the verbose log output.
 
 ### <a href="#conf-file" id="conf-file" name="conf-file">File</a>
 
-The YAML configuration file is described in the [`doc/configuration.md`] file.
-Also, there is a sample configuration file `config.dist.yaml`.
+The YAML configuration file is described in the [`doc/configuration.md`] file,
+and there is also a sample configuration file `config.dist.yaml`.  Some
+configuration parameters can also be overridden using the environment, see
+[`doc/environment.md`].
 
 [`doc/configuration.md`]: doc/configuration.md
+[`doc/environment.md`]:   doc/environment.md
 
 ## <a href="#exit-codes" id="exit-codes" name="exit-codes">Exit codes</a>
 
@@ -139,5 +139,3 @@ conditions:
 - `1`: Internal error, most probably misconfiguration.
 
 - `2`: Bad command-line argument or its value.
-
-<!-- TODO(e.burkov): Add GitHub issue templates. -->

doc/configuration.md

@@ -41,7 +41,7 @@ following properties:
     **Example:** `128MB`.
 
  *  <a href="#dns-cache-client-size" id="dns-cache-client-size" name="dns-cache-client-size">`client_size`</a>:
-    The maximum size of the DNS results cache for each configured client's
+    The maximum size of the DNS results cache for each configured client’s
     address or subnetwork as human-readable data size.  It must be greater than
     zero if [`enabled`](#dns-cache-enabled) is `true`.
 
@@ -98,11 +98,11 @@ following properties:
 
 
  *  <a href="#dns-upstream-groups" id="dns-upstream-groups" name="dns-upstream-groups">`groups`</a>:
-    The set of upstream servers keyed by the group's name.  It has the following
+    The set of upstream servers keyed by the group’s name.  It has the following
     fields:
 
      *  <a href="#dns-upstream-group-address" id="dns-upstream-group-address" name="dns-upstream-group-address">`address`</a>:
-        The upstream server's address.
+        The upstream server’s address.
 
         **Example:** `'8.8.8.8:53'`.
 
@@ -117,7 +117,7 @@ following properties:
             **Example:** `'mycompany.local'`.
 
          *  <a href="#dns-upstream-group-match-client" id="dns-upstream-group-match-client" name="dns-upstream-group-match-client">`client`</a>:
-            The client's address or a subnet of the client's address that the
+            The client’s address or a subnet of the client’s address that the
             set of upstream servers should be used to resolve requests from.  It
             must have no significant bits outside of the subnet mask.
 
@@ -132,7 +132,7 @@ following properties:
         'match':
           - question_domain: 'mycompany.local'
             client: '192.168.1.0/24'
-          - question_domain: 'mycompany.extrenal'
+          - question_domain: 'mycompany.external'
           - client: '1.2.3.4'
         ```