diff --git a/Readme.md b/Readme.md index b0ffce5..0d792a5 100644 --- a/Readme.md +++ b/Readme.md @@ -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: