]> git.frustrated-labs.net Git - dns-phrasex.git/commitdiff
docs: update README
authorAlexander Goussas <[email protected]>
Sun, 1 Feb 2026 20:29:52 +0000 (15:29 -0500)
committerAlexander Goussas <[email protected]>
Sun, 1 Feb 2026 20:29:52 +0000 (15:29 -0500)
README.md

index 11826dca2d6a10170f43599b8f53ccfe8865b0bb..989927a7f6964afaf4ce7f203fd80eae9b86ce2b 100644 (file)
--- 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 <https://hexdocs.pm/dns_phrases>.
-
+## License
+MIT