From e2482fe5486a726713c2a0765bb15c69e7cc00ef Mon Sep 17 00:00:00 2001 From: LittleChest Date: Wed, 23 Apr 2025 21:35:26 +0800 Subject: [PATCH] docs: Add README.md --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..098f7c8 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# Dohna NS + +Another DNS over HTTPS recursive resolver. + +- [x] EDNS Client Subnet +- [x] [JSON API](https://developers.google.com/speed/public-dns/docs/doh/json) + +## For Users + +Read [Dohna NS Documentation](https://dohna-ns.sbs/) to learn how to install Dohna NS on your device. + +## Deploy + +| Provider | Deploy | +| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Cloudflare | [![Deploy to Cloudflare](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/LittleChest/Dohna-NS) | +| Vercel | [![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/LittleChest/Dohna-NS) | +| Netlify | [![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/LittleChest/Dohna-NS) | + +## Self-hosted + +You can use [Netlify CLI](https://cli.netlify.com/commands/serve/) or [`workerd`](https://github.com/cloudflare/workerd/blob/main/README.md#getting-started) **(Recommended)** to serve locally. + +Make sure you can connect to upstream servers. + +If you find a bug on self-hosted, try to reproduce it at `dohna-ns.sbs` before reporting it.