arianagiroux/DockOfOurOwn
1
0
Fork 0
Code Issues Pull requests Projects 3 Releases Wiki Activity

Added a simple project description to Readme.md

Browse source
This commit is contained in:
Ariana Giroux 2022-08-05 14:48:52 -06:00
parent 018b624f19
commit c509b515a3
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
Readme.md
View file

@ -1,3 +1,14 @@
# DockOfOurOwn
## Project Description
This project is a simple attempt at extending the fucntionality of [the Owncast project](https://owncast.online/) to improve the streamer quality of life. While [the Owncast project](https://owncast.online/) provides a fully functionaly 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 embedable method of obtaining the viewer count, stream title, etc.
This repository provides a bare bones embedable 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.
## Instilation
First, clone the repository: