From fa5b3cc274c2ae818b63d6fb69b6e02feda98225 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Leon=20Gr=C3=BCnewald?= <leon@doggoat.de>
Date: Mon, 1 Jan 2024 22:16:58 +0100
Subject: [PATCH] Add decent README.md

---
 README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)

diff --git a/README.md b/README.md
index c4cbfaf..6d1ee1f 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,55 @@
 # r621
+
+A simple e621 client using requwest.  
+
+## Features
+
+### Implemented
+- Post
+  - Listing
+
+### Missing
+- Post
+  - Create
+  - Update
+  - Flag
+  - Vote
+  - Favorite
+- Favorites
+  - Listing
+  - Create
+  - Delete
+- Tags
+  - Listing
+- Tag Aliases
+  - Listing
+- Tag Implications
+  - Listing
+- Notes
+  - Listing
+  - Create
+  - Update
+- Pools
+  - Listing
+  - Create
+  - Update
+  - Revert
+
+## Example Usage
+
+```rust
+use r621::client::{Authentication, Client};
+use r621::post::Post;
+
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    let user_agent = "MyProject/1.0 (by username on e621)";
+    let auth = Authentication::Authorized {
+        username: "hexerade",
+        apikey: "1nHrmzmsvJf26EhU1F7CjnjC"
+    };
+    
+    let mut esix_client = Client::new(auth, user_agent);
+    let posts = esix_client.list_posts(None, query, None).await?;
+}
+```
\ No newline at end of file