From 4188e0ea5b8f5728bc3a70ed48d430cdfac0fea9 Mon Sep 17 00:00:00 2001 From: Richard Schneider Date: Fri, 24 May 2019 14:24:57 +1200 Subject: [PATCH] docs: improve #1 --- appveyor.yml | 2 +- doc/MSBuild.dll.config | 112 ----------------------------------------- doc/articles/intro.md | 18 ++++--- doc/packages.config | 7 --- doc/toc.yml | 2 + src/DohClient.cs | 2 +- 6 files changed, 16 insertions(+), 127 deletions(-) delete mode 100644 doc/MSBuild.dll.config delete mode 100644 doc/packages.config diff --git a/appveyor.yml b/appveyor.yml index e29cb95..1de19e3 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -67,7 +67,7 @@ after_test: packages\coveralls.net.0.6.0\tools\csmacnz.coveralls.exe --opencover -i ./coverage.xml --useRelativePaths --serviceName appveyor --jobId %APPVEYOR_BUILD_NUMBER% # Build documentation in doc\_site - - del src\obj\*.* /s /q +# - del src\obj\*.* /s /q - docfx doc\docfx.json --logLevel Warning - 7z a -tzip docs.zip doc\_site - appveyor PushArtifact docs.zip diff --git a/doc/MSBuild.dll.config b/doc/MSBuild.dll.config deleted file mode 100644 index 3e1c5af..0000000 --- a/doc/MSBuild.dll.config +++ /dev/null @@ -1,112 +0,0 @@ - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/articles/intro.md b/doc/articles/intro.md index e82d2cf..3bc0768 100644 --- a/doc/articles/intro.md +++ b/doc/articles/intro.md @@ -1,13 +1,19 @@ # DNS Clients -Various DNS clients that communicate with a DNS server. The source code is on [GitHub](https://github.com/richardschneider/net-udns) and the package is published on [NuGet](https://www.nuget.org/packages/Makaretu.Dns.Unicast). +This package provides various unicast DNS clients, stub resolvers, that communicate with a DNS server. The source code is on [GitHub](https://github.com/richardschneider/net-udns) and the package is published on [NuGet](https://www.nuget.org/packages/Makaretu.Dns.Unicast). - [DnsClient](xref:Makaretu.Dns.DnsClient) is used to send a [Message](xref:Makaretu.Dns.Message) - to a standard DNS server and receive a response; uses UPD and then TCP (if needed). -- [DohClient](xref:Makaretu.Dns.DohClient) is used to send a [Message](xref:Makaretu.Dns.Message) - to a DNS over HTTPS server and receive a response. -- [DotClient](xref:Makaretu.Dns.DotClient) is used to send a [Message](xref:Makaretu.Dns.Message) - to a DNS over TLS server and receive a response. + to a standard DNS server and receive a response; uses UPD and then TCP (if needed). There is no privacy. + +- [DohClient](xref:Makaretu.Dns.DohClient), DNS over HTTPS (DoH), is an experimental protocol for performing remote +Domain Name System (DNS) resolution via the HTTPS protocol. The goal +is to increase user privacy and security by preventing eavesdropping and +manipulation of DNS data by man-in-the-middle attacks. + +- [DotClient](xref:Makaretu.Dns.DotClient), DNS over TLS (DoT), is a security protocol for encrypting and wrapping +DNS queries and answers via the Transport Layer Security (TLS) protocol. The goal +is to increase user privacy and security by preventing eavesdropping and +manipulation of DNS data via man-in-the-middle attacks. ## Usage diff --git a/doc/packages.config b/doc/packages.config deleted file mode 100644 index cad44f5..0000000 --- a/doc/packages.config +++ /dev/null @@ -1,7 +0,0 @@ - - - - - - - \ No newline at end of file diff --git a/doc/toc.yml b/doc/toc.yml index c3ae452..d070daf 100644 --- a/doc/toc.yml +++ b/doc/toc.yml @@ -2,3 +2,5 @@ href: articles/ - name: Api Documentation href: api/ +- name: Github + href: https://github.com/richardschneider/net-udns diff --git a/src/DohClient.cs b/src/DohClient.cs index b59aae0..6c43574 100644 --- a/src/DohClient.cs +++ b/src/DohClient.cs @@ -23,7 +23,7 @@ namespace Makaretu.Dns /// manipulation of DNS data by man-in-the-middle attacks. /// /// The DohClient uses the HTTP POST method to hide as much - /// information as is possible. Also, it tends to generated smaller + /// information as is possible. Also, it tends to generate smaller /// requests. /// ///