From fad190cb29b73becedc6dc8fe9f416afc47bdad5 Mon Sep 17 00:00:00 2001 From: Alexander Goussas Date: Sun, 1 Feb 2026 15:29:52 -0500 Subject: [PATCH] docs: update README --- README.md | 23 +++++++---------------- 1 file changed, 7 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 11826dc..989927a 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,12 @@ -# DnsPhrases +# DnsPhrasex -**TODO: Add description** +This is a DNS server that responds to queries with TXT records containing random phrases. -## Installation +## Usage -If [available in Hex](https://hex.pm/docs/publish), the package can be installed -by adding `dns_phrases` to your list of dependencies in `mix.exs`: - -```elixir -def deps do - [ - {:dns_phrases, "~> 0.1.0"} - ] -end +```bash +dig @dns.frustrated-functor.dev ``` -Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc) -and published on [HexDocs](https://hexdocs.pm). Once published, the docs can -be found at . - +## License +MIT -- 2.43.0