VDMDI/UDN
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

improve docs

Browse Source
This commit is contained in:
marlon-erler
2024-07-08 18:46:32 +02:00
parent 175b2619d3
commit 07135802ff
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3 -2
View File
@@ -131,7 +131,8 @@ As you can see, there are many ways to connect multiple servers and communicate
1. Apps are likely hosted as websites on the internet or your local network. If this is not the case, follow instructions given by the developers or your administrator. 1. Apps are likely hosted as websites on the internet or your local network. If this is not the case, follow instructions given by the developers or your administrator.
2. To use an app, **open it in your web browser**. Most apps will install offline support automatically so you can use them on local networks without an internet connection. 2. To use an app, **open it in your web browser**. Most apps will install offline support automatically so you can use them on local networks without an internet connection.
3. If you are using a smartphone, **add the app to your homescreen and launch it**. 3. If you are using a smartphone, **add the app to your homescreen and launch it**.
4. If the app requests your server address, consider: 4. If you are using a computer, you can **install the app as PWA**, you can find this option in the share sheet or browser menu. Please google how to do this in your specific browser.
5. If the app requests your server address, note that:
- `http://` or `https://` (the secure variant) are protocols to request data and receive a single response - `http://` or `https://` (the secure variant) are protocols to request data and receive a single response
- To send messages, apps use so-called WebSockets instead. Their protocol is `ws://` or `wss://` (the secure variant) - To send messages, apps use so-called WebSockets instead. Their protocol is `ws://` or `wss://` (the secure variant)
@@ -145,7 +146,7 @@ Anyone can develop apps for the UDN project. Examples of such apps are listed be
| App Name | Description | Links | | App Name | Description | Links |
| -- | -- | -- | | -- | -- | -- |
| Broadcast | Simple broadcast-based messenger for UDN | [view code](https://github.com/marlon-erler/udn-broadcast/) - [get](https://udn-broadcast.onrender.com/) | Broadcast | Simple broadcast-based messenger for UDN | [more info](https://github.com/marlon-erler/udn-broadcast/) - [install](https://udn-broadcast.onrender.com/)
--- ---