add documentation

2024-07-08 18:45:03 +02:00
parent 2f598440d1
commit 19156d6179
1 changed files with 14 additions and 2 deletions
@@ -1,4 +1,16 @@
 # udn-broadcast
-Simple broadcast-based messenger for UDN

-Use or install the web app [here](https://udn-broadcast.onrender.com/)
+UDN-Broadcast is a simple broadcast-based messenger built for [UDN](https://github.com/marlon-erler/universal-decentralized-network).
+
+# Features
+- Offline support
+- Encryption
+- Secondary channels
+
+# Getting Started
+1. Use or install the web app [here](https://udn-broadcast.onrender.com/)
+2. Connect to your server
+3. Enter your name and primary channel
+4. Add secondary channels if needed
+5. Define encryption key if needed
+6. Start messaging