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

Added a simple project description to Readme.md

This commit is contained in:
Ariana Giroux 2022-08-05 14:48:52 -06:00
parent 018b624f19
commit 8760b83b50
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Readme.md
View File

@ -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: