Clean up the github readme and add some fun badges for surfacing some links and info
This commit is contained in:
Gabe Kangas
parent
37fedb8ab8
commit
fcc25bd1e7
48
README.md
48
README.md
@ -4,9 +4,10 @@
|
||||
<img src="https://owncast.online/images/logo.png" alt="Logo" width="200">
|
||||
</a>
|
||||
|
||||
<br/>
|
||||
|
||||
<p align="center">
|
||||
Take control over your content and stream it yourself.
|
||||
<h2>Take control over your content and stream it yourself.</h2>
|
||||
<br />
|
||||
<a href="http://owncast.online"><strong>Explore the docs »</strong></a>
|
||||
<br />
|
||||
@ -22,21 +23,22 @@
|
||||
</p>
|
||||
|
||||
<!-- TABLE OF CONTENTS -->
|
||||
|
||||
## Table of Contents
|
||||
|
||||
* [About the Project](#about-the-project)
|
||||
* [Getting Started](#getting-started)
|
||||
* [Getting Started](#getting-started)
|
||||
* [Configuration](#configuration)
|
||||
* [Web Interface & Chat](#web-interface--chat)
|
||||
* [Use with your broadcasting software](#use-with-your-existing-broadcasting-software)
|
||||
* [Video storage and distribution options](#video-storage-options)
|
||||
* [Building from source](#building-from-source)
|
||||
* [License](#license)
|
||||
* [Contact](#contact)
|
||||
|
||||
- [About the Project](#about-the-project)
|
||||
- [Getting Started](#getting-started)
|
||||
- [Getting Started](#getting-started)
|
||||
- [Configuration](#configuration)
|
||||
- [Web Interface & Chat](#web-interface--chat)
|
||||
- [Use with your broadcasting software](#use-with-your-existing-broadcasting-software)
|
||||
- [Video storage and distribution options](#video-storage-options)
|
||||
- [Building from source](#building-from-source)
|
||||
- [License](#license)
|
||||
- [Contact](#contact)
|
||||
|
||||
<!-- ABOUT THE PROJECT -->
|
||||
|
||||
## About The Project
|
||||
|
||||
<p align="center">
|
||||
@ -45,13 +47,19 @@
|
||||
</a>
|
||||
</p>
|
||||
|
||||
In 2020 the world changed when everyone become stuck in their homes, looking for creative outlets to share their art, skills and themselves from inside their bedroom.
|
||||
Owncast is an open source, self-hosted, decentralized, single user live streaming and chat server for running your own live streams similar in style to the large mainstream options. It offers complete ownership over your content, interface, moderation and audience. <a href="https://watch.owncast.online">Visit the demo</a> for an example.
|
||||
|
||||
This created an explosion of live streaming on Facebook Live, YouTube Live, Instagram, and Twitch. These services provided everything they needed, an easy way to live stream to the world, and a chat for users to be a part of their community.
|
||||
<div>
|
||||
<img alt="GitHub all releases" src="https://img.shields.io/github/downloads/owncast/owncast/total?style=for-the-badge">
|
||||
<img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/gabekangas/owncast?style=for-the-badge">
|
||||
<a href="https://github.com/owncast/owncast/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22">
|
||||
<img alt="GitHub issues by-label" src="https://img.shields.io/github/issues-raw/owncast/owncast/good%20first%20issue?style=for-the-badge">
|
||||
</a>
|
||||
<a href="https://opencollective.com/owncast">
|
||||
<img alt="Open Collective backers and sponsors" src="https://img.shields.io/opencollective/all/owncast?style=for-the-badge">
|
||||
</a>
|
||||
</div>
|
||||
|
||||
That's when I wanted a better option for people. Something you could run yourself and get all the functionality of these services, where you could live stream to an audience and and allow them to take part in the chat, just like they've been used to on all the other services. **There should be a independent, standalone _Twitch in a Box_.**
|
||||
|
||||
**Keep in mind that while streaming to the big social companies is always free, you pay for it with your identity and your data, as well as the identity and data of every person that tunes in. When you self-host anything you'll have to pay with your money instead. But running a self-hosted live stream server can be done for as cheap as $5/mo, and that's a much better deal than selling your soul to Facebook, Google or Amazon.**
|
||||
|
||||
---
|
||||
|
||||
@ -96,7 +104,6 @@ Instead of serving video directly from your personal server you can use a S3 com
|
||||
|
||||
Read [more detailed documentation about configuration of S3-compatible services](https://owncast.online/docs/s3/).
|
||||
|
||||
|
||||
## Building from Source
|
||||
|
||||
1. Ensure you have the gcc compiler configured.
|
||||
@ -107,7 +114,6 @@ Read [more detailed documentation about configuration of S3-compatible services]
|
||||
|
||||
There is also a supplied `Dockerfile` so you can spin it up from source with little effort. [Read more about running from source](https://owncast.online/docs/building/).
|
||||
|
||||
|
||||
### Bundling in latest admin from source
|
||||
|
||||
The admin ui is built at: https://github.com/owncast/owncast-admin it is bundled into the final binary using pkger.
|
||||
@ -119,13 +125,13 @@ To bundle in the latest admin UI:
|
||||
1. Compile or run like above. `go run main.go pkged.go`
|
||||
|
||||
<!-- LICENSE -->
|
||||
|
||||
## License
|
||||
|
||||
Distributed under the MIT License. See `LICENSE` for more information.
|
||||
|
||||
|
||||
|
||||
<!-- CONTACT -->
|
||||
|
||||
## Contact
|
||||
|
||||
Project chat: [Join us on Rocket.Chat](https://owncast.rocket.chat/home) if you want to contribute, follow along, or if you have questions.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user