Skip to content

Commit cda0a47

Browse files
committed
Add documentation index
1 parent 7bccc80 commit cda0a47

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

Sources/DNSKit/Docs.docc/index.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# ``DNSKit``
2+
3+
An asynchronous DNS library for Swift.
4+
5+
DNSKit provides a wide array of support across the DNS ecosystem, including:
6+
7+
- Native support for most common DNS record types.
8+
- Support for DNS over HTTPS, DNS over TLS, DNS over Quic, and traditional DNS using TCP or UDP.
9+
- Full DNSSEC signature validation & chain trust establishment.
10+
- WHOIS client for domain information.
11+
12+
## Getting Started
13+
14+
Use the initalizer to the Query class, ``Query/init(transportType:transportOptions:serverAddresses:recordType:name:queryOptions:)``,
15+
to define your query, the DNS server to use, and to execute your query and get the response.
16+
17+
### WHOIS
18+
19+
Use the ``WHOISClient/lookup(_:)`` class to perform WHOIS lookups
20+
21+
### DNSSEC
22+
23+
Re-using the same query you used to perform your query, call ``Query/authenticate(message:)``. Be sure that ``QueryOptions/dnssecRequested``
24+
was set to true in your original query.

0 commit comments

Comments
 (0)