From 8760b83b5020764cfc4cdf33298c8d0e07e3e497 Mon Sep 17 00:00:00 2001 From: arianagiroux Date: Fri, 5 Aug 2022 14:48:52 -0600 Subject: [PATCH] Added a simple project description to Readme.md --- Readme.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/Readme.md b/Readme.md index b0ffce5..0958fda 100644 --- a/Readme.md +++ b/Readme.md @@ -1,4 +1,15 @@ -## Instilation +# DockOfOurOwn + +## Project Description + +This project is a simple attempt at extending the functionality of [the Owncast project](https://owncast.online/) to improve the streamer quality of life. While [the Owncast project](https://owncast.online/) provides a fully functionally chat monitoring and moderating widget that can be used as a dock in streaming platforms like OBS ([found here](https://owncast.online/docs/embed/#embedding-standalone-chat)), there is (as of [Owncast v0.0.12](https://github.com/owncast/owncast/releases/tag/v0.0.12)) no embeddable method of obtaining the viewer count, stream title, etc. + +This repository provides a bare bones embeddable widget that can be used as a Dock that provides important details like viewer count and what the current stream tags are, and enables the streamer to update important stream details without needing a browser open. + +This project should not be considered production ready. + + +## Installation First, clone the repository: @@ -28,7 +39,7 @@ Next, run the flask app: flask run -This will start a webserver which can be accessed, by default, at http://127.0.0.1:5000/. This webapp is what you should point an OBS custom browser dock too. Note, check the [flask documentation](https://flask.palletsprojects.com/en/2.2.x/cli/#setting-command-options) for more on how to set specific ports for the webapp. +This will start a web server which can be accessed, by default, at http://127.0.0.1:5000/. This webapp is what you should point an OBS custom browser dock too. Note, check the [flask documentation](https://flask.palletsprojects.com/en/2.2.x/cli/#setting-command-options) for more on how to set specific ports for the webapp. Next, using OBS, select Docks from the top bar, and find the Custom Browser Docks option. In the subsequent dialog, point a line item at the aforementioned address and port combination (http://127.0.0.1:5000/). This should embed the webapp within OBS.