From ab8249e0bfa041c016152fcf50bc6d56e7f45df4 Mon Sep 17 00:00:00 2001 From: Iris Lightshard Date: Sat, 7 Dec 2024 18:15:45 -0700 Subject: [PATCH] update README a bit --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7e7365e..3bf4fa8 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,7 @@ underBBS is a protocol-agnostic decentralized social media client and toolkit `underbbs` supports multiple simultaneous account logins, mediating them for each user through a gateway server that handles all protocol-specific logic via `adapter`s and streaming content to the user through a single websocket connection with a singular data interface. -each distinct `adapter` connection/configuration is represented in the frontend as a tab, and using the websocket's event-driven javascript interface with web components we can simply either store the data or tell the currently visible adapter that it might need to respond to the new data - -adapters receive commands via a quartzgun web API and send data back on their shared websocket connection +adapters receive commands via a quartzgun web API and send data back on their shared websocket connection; when data comes in on the websocket, `underbbs` will save it and then notify any relevant web components that the data has changed. ### CLI @@ -36,7 +34,7 @@ from the project root: ### with the API and web components 1. fill `Settings._instance` with adapter settings; these will mostly be authentication data (`SettingsElement` illustrates this) -2. instantiate whatever components you want on your page with their `data-gateway` and `data-target` appropriately set; further docs to come on these +2. instantiate whatever components you want on your page with their `data-adapter`, `data-gateway` and `data-target` appropriately set; further docs to come on these 3. call `DatagramSocket.connect(GATEWAY)` where `GATEWAY` is the domain of the `underbbs` API. `SettingsElement`'s connect button does this for you. ### with the CLI