docs: Update README.md

getAlby · Oct 8, 2024 · 281b2fb · 281b2fb
1 parent 26f0f8e
commit 281b2fb
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,26 @@
 
 A minimal Lightning address server powered by [NWC](https://nwc.dev)
 
+## API
+
+### Create a new user
+
+`POST /users`
+
+```json
+{
+    "connectionSecret": "nostr+walletconnect://..."
+}
+```
+
+`returns`
+
+```
+{
+    "lightningAddress": "91290133601@albylite.com"
+}
+```
+
 ## Development
 
 - [Install Deno](https://docs.deno.com/runtime/manual/getting_started/installation/)