From be0b2c78d45df58e35bed899be2c70dc8c5b1c7b Mon Sep 17 00:00:00 2001
From: Ashlynne Mitchell <ovy@ovyerus.com>
Date: Sat, 7 Jun 2025 22:30:20 +1000
Subject: [PATCH] docs: update README

---
 LICENSE   | 18 ++++++++++++++++++
 README.md | 27 +++++++++++++++++++--------
 2 files changed, 37 insertions(+), 8 deletions(-)
 create mode 100644 LICENSE

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..ac053b5
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,18 @@
+Copyright 2025 comet.sh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
index 56bb013..41626e0 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,32 @@
-# Atex
+# atex
 
-**TODO: Add description**
+A set of utilities for working with the [AT Protocol](https://atproto.com) in
+Elixir.
+
+## Current Roadmap (in no particular order)
+
+- [x] `at://` parsing and struct
+- [ ] XRPC client
+- [ ] CID & TID codecs
+- [ ] DID & handle resolution service with a cache
+- [ ] Structs with validation for the common lexicons
+  - [ ] Probably codegen for doing this with other lexicons
+- [ ] Oauth stuff
 
 ## Installation
 
-If [available in Hex](https://hex.pm/docs/publish), the package can be installed
-by adding `atex` to your list of dependencies in `mix.exs`:
+Get atex from [hex.pm](https://hex.pm) by adding it to your `mix.exs`:
 
 ```elixir
 def deps do
   [
-    {:atex, "~> 0.1.0"}
+    {:atex, "~> 0.1"}
   ]
 end
 ```
 
-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/atex>.
+Documentation can be found on HexDocs at https://hexdocs.pm/atex.
+
+---
 
+This project is licensed under the [MIT License](./LICENSE).
-- 
2.51.2