Skip to content

Commit

Permalink
Merge pull request #20 from richardschneider/1-doc
Browse files Browse the repository at this point in the history
docs: improve
  • Loading branch information
richardschneider committed May 24, 2019
2 parents 4970552 + 4188e0e commit 980792b
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 127 deletions.
2 changes: 1 addition & 1 deletion appveyor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
112 changes: 0 additions & 112 deletions doc/MSBuild.dll.config

This file was deleted.

18 changes: 12 additions & 6 deletions doc/articles/intro.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
7 changes: 0 additions & 7 deletions doc/packages.config

This file was deleted.

2 changes: 2 additions & 0 deletions doc/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,5 @@
href: articles/
- name: Api Documentation
href: api/
- name: Github
href: https://github.com/richardschneider/net-udns
2 changes: 1 addition & 1 deletion src/DohClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ namespace Makaretu.Dns
/// manipulation of DNS data by man-in-the-middle attacks.
/// <para>
/// The <b>DohClient</b> 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.
/// </para>
/// </remarks>
Expand Down

0 comments on commit 980792b

Please sign in to comment.