v0.4.10 - api

README.md

@@ -1,8 +1,8 @@
-# C Nostr Relay - Event-Based Configuration System
+# C-Nostr Relay 
 
 A high-performance Nostr relay implemented in C with SQLite backend, featuring a revolutionary **zero-configuration** approach using event-based configuration management.
 
-## 📜 Supported NIPs
+## Supported NIPs
 
 <!--
 NOTE FOR ASSISTANTS: When updating the NIPs checklist below, ONLY change [ ] to [x] to mark as complete.
@@ -22,7 +22,7 @@ Do NOT modify the formatting, add emojis, or change the text. Keep the simple fo
 - [x] NIP-50: Keywords filter
 - [x] NIP-70: Protected Events
 
-## 🌐 Web Admin Interface
+## Web Admin Interface
 
 C-Relay includes a **built-in web-based administration interface** accessible at `http://localhost:8888/api/`. The interface provides:
 
@@ -34,7 +34,7 @@ C-Relay includes a **built-in web-based administration interface** accessible at
 
 The web interface serves embedded static files with no external dependencies and includes proper CORS headers for browser compatibility.
 
-## 🔧 Administrator API
+## Administrator API
 
 C-Relay uses an innovative **event-based administration system** where all configuration and management commands are sent as signed Nostr events using the admin private key generated during first startup. All admin commands use **NIP-44 encrypted command arrays** for security and compatibility.
 
@@ -256,4 +256,28 @@ All admin commands return **signed EVENT responses** via WebSocket following sta
   ],
   "sig": "response_event_signature"
 }]
+
+
 ```
+
+
+
+
+
+
+##  Direct Messaging Admin System
+
+In addition to the above admin API, c-relay allows the administrator to direct message the relay to get information or control some settings. As long as the administrator is signed in with any nostr client that allows sending nip-17 direct messages (DMs), they can control the relay.
+
+The is possible because the relay is a full nostr citizen with it's own private and public key.
+
+
+
+**Available DM commands**
+
+The intent is not to be strict in the formatting of the DM. So for example if the relay receives any DM from the administrator with the words "stats" or "statistics" in it, it will respond to the administrator with a reply DM with the current relay statistics.
+
+- `stats`|`statistics`: Relay statistics
+- `config`|`configuration`: Relay configuration
+
+