From 5efdde6668ec2d3cf7072df4c2518a57361f0e14 Mon Sep 17 00:00:00 2001
From: lewdum <lewdum@proton.me>
Date: Tue, 22 Oct 2024 19:28:08 -0300
Subject: [PATCH] README

---
 README.md | 36 ++++++++++++++++++++++++++++++------
 1 file changed, 30 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index fac6c69..993f723 100644
--- a/README.md
+++ b/README.md
@@ -3,22 +3,46 @@
 [![Package Version](https://img.shields.io/hexpm/v/apkallone)](https://hex.pm/packages/apkallone)
 [![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/apkallone/)
 
+Bindings to the [Mastodon], [Pleroma], and [Misskey] APIs.
+
+[Mastodon]: https://joinmastodon.org/
+[Pleroma]: https://pleroma.social/
+[Misskey]: https://misskey-hub.net/en/
+
 ```sh
-gleam add apkallone@1
+gleam add apkallone@0
 ```
 ```gleam
 import apkallone
+import apkallone/mastodon/instance
 
 pub fn main() {
-  // TODO: An example of the project in use
+  let assert Ok(instance) =
+    apkallone.Client("https://tech.lgbt")
+    |> instance.get
+
+  io.debug(instance)
 }
 ```
 
 Further documentation can be found at <https://hexdocs.pm/apkallone>.
 
+API documentation can be found at the official pages for [Mastodon], [Pleroma], and [Misskey].
+
+[Mastodon]: https://docs.joinmastodon.org/api/
+[Pleroma]: https://api.pleroma.social/
+[Misskey]: https://misskey-hub.net/en/docs/for-developers/api/
+
 ## Development
 
-```sh
-gleam run   # Run the project
-gleam test  # Run the tests
-```
+This library is in development. Most functionality is unimplemented.
+
+Currently only the Erlang target is supported, for lack of a target-agnostic HTTP client.
+
+## Planned features
+
+- [ ] Authenticated requests.
+- [ ] User-provided HTTP client.
+- [ ] The full Mastodon API.
+- [ ] The full Pleroma/Akkoma API.
+- [ ] The full Misskey/IceShrimp/Sharkey API.