summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorhyperion <hyperion@spacekookie.de>2020-10-30 12:08:17 +0100
committerhyperion <hyperion@spacekookie.de>2020-10-30 12:08:17 +0100
commit8cc834e1c3913ef1ab30f7a061fa9ced83fce616 (patch)
tree119b64a0c53ab5cbc85e34e443b8c8a55ea3a9eb /README.md
parentcc22f1c3a2e24ef366ebe9a11c463075cd0263d3 (diff)
Updating README
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 5 insertions, 6 deletions
diff --git a/README.md b/README.md
index 319dfca..87995cb 100644
--- a/README.md
+++ b/README.md
@@ -9,17 +9,16 @@ A minimal self-hostable streaming setup.
## Setup
`brook` is a modular project, meaning that many different components
-come together to provide a simple and relatively lightweight streaming
-setup. Following is a quick overview of components.
+come together to provide a lightweight streaming setup. Following is
+a quick overview of components.
* `ffmpeg` - running an rtmp server, and converting video to `dash`
output format
* `nginx` - serves the `dash` directory
-* `index.html` - static html file with js for a dash player and xmpp
- web chat
-* `brook-metrics` - the only custom server-side program to track
- viewer metrics
* `prosody` - An XMPP server to back the chat room
+* `brook-web` - a simple static HTML front-end, supporting dash.js
+ video playback, and an XMPP web chat via converse.js
+* `brook-metrics` - a server-side service to track viewer metrics
## Configuration