A set of utilities for working with the AT Protocol in Elixir.

docs: update README

ovyerus.com be0b2c78 c1a10b9a

verified
Changed files
+37 -8
+18
LICENSE
··· 1 + Copyright 2025 comet.sh 2 + 3 + Permission is hereby granted, free of charge, to any person obtaining a copy of 4 + this software and associated documentation files (the “Software”), to deal in 5 + the Software without restriction, including without limitation the rights to 6 + use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 7 + the Software, and to permit persons to whom the Software is furnished to do so, 8 + subject to the following conditions: 9 + 10 + The above copyright notice and this permission notice shall be included in all 11 + copies or substantial portions of the Software. 12 + 13 + THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 15 + FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 16 + COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 17 + IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 18 + CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+19 -8
README.md
··· 1 - # Atex 1 + # atex 2 + 3 + A set of utilities for working with the [AT Protocol](https://atproto.com) in 4 + Elixir. 5 + 6 + ## Current Roadmap (in no particular order) 2 7 3 - **TODO: Add description** 8 + - [x] `at://` parsing and struct 9 + - [ ] XRPC client 10 + - [ ] CID & TID codecs 11 + - [ ] DID & handle resolution service with a cache 12 + - [ ] Structs with validation for the common lexicons 13 + - [ ] Probably codegen for doing this with other lexicons 14 + - [ ] Oauth stuff 4 15 5 16 ## Installation 6 17 7 - If [available in Hex](https://hex.pm/docs/publish), the package can be installed 8 - by adding `atex` to your list of dependencies in `mix.exs`: 18 + Get atex from [hex.pm](https://hex.pm) by adding it to your `mix.exs`: 9 19 10 20 ```elixir 11 21 def deps do 12 22 [ 13 - {:atex, "~> 0.1.0"} 23 + {:atex, "~> 0.1"} 14 24 ] 15 25 end 16 26 ``` 17 27 18 - Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc) 19 - and published on [HexDocs](https://hexdocs.pm). Once published, the docs can 20 - be found at <https://hexdocs.pm/atex>. 28 + Documentation can be found on HexDocs at https://hexdocs.pm/atex. 21 29 30 + --- 31 + 32 + This project is licensed under the [MIT License](./LICENSE).