Skip to content

Commit 03e29f3

Browse files
committed
Documentation: Go API section
1 parent f7fdf0f commit 03e29f3

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,15 @@ This container requires the following connections:
218218

219219
Note that [https://1.1.1.1/help](https://1.1.1.1/help) does not work as the container is not a client to Cloudflare servers but a forwarder intermediary. Hence https://1.1.1.1/help does not detect a direct connection to them.
220220

221+
## Go API
222+
223+
Some packages are exposed publicly through the [pkg](pkg) directory.
224+
225+
The API is at v1.x.x but (shame on me) is not stable and subject to change without
226+
changing version. If you need it to be stable, please [create an issue](https://github.com/qdm12/dns/issues/new).
227+
228+
For now, it is used by the [gluetun](https://github.com/qdm12/gluetun) project for its DNS over TLS usage.
229+
221230
## Development
222231

223232
1. Setup your environment

0 commit comments

Comments
 (0)