update README

AbstractUmbra · Aug 9, 2024 · 7eb7bc4 · 7eb7bc4
1 parent 5b0d840
commit 7eb7bc4
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -20,6 +20,17 @@ paused
 repeating
 ```
 
+### JSON API
+
+This project now exposes a headless JSON API on request. This is available on the following:
+```
+POST https://anilist.abstractumbra.dev/
+{
+    "users": ["User1", "User2"], # supports N many users
+    "status": "planning" # defaults to 'planning'
+}
+```
+
 ## Running your own
 
 The provided docker-compose file should work on its own.