From ef72021f87b93dad9ab46a24c623b53ac5832341 Mon Sep 17 00:00:00 2001 From: Germaine Lee <118464031+germainelee@users.noreply.github.com> Date: Fri, 31 May 2024 14:55:40 -0400 Subject: [PATCH] Update README.md (#3756) - Add MIT license badge - Update TOC - Update Contributing and add Backer section that lists backers from Open Collective (PS. practising my html so that they don't go rusty) --- README.md | 63 ++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 44 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 33cffb16e..ebe24e87c 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,48 @@ -

- Logo + Owncast Logo + +

+ +

+ Take control over your content and stream it yourself. +

+ +
+ +

+ + License


-

- Take control over your content and stream it yourself. -
- Explore the docs » -
- View Demo - · - FAQ - · - Report Bug -

+

+ Explore the docs » +
+ View Demo + · + FAQ + · + Report Bug

+ ## Table of Contents -- [About the Project](#about-the-project) -- [Getting Started](#getting-started) -- [Use with your broadcasting software](#use-with-your-existing-broadcasting-software) -- [Building from source](#building-from-source) -- [Contributing](#contributing) -- [License](#license) +- 📒 [About the Project](#about-the-project) +- 🚀 [Getting Started](#getting-started) +- 👨‍💻 [Use with your broadcasting software](#use-with-your-existing-broadcasting-software) +- 🛠 [Building from source](#building-from-source) + - 🚨 [Important note about source code and the develop branch](#important-note-about-source-code-and-the-develop-branch) + - 🗄️ [Backend](#backend) + - ⚛️ [Frontend](#frontend) +- 👏 [Contributing](#contributing) + - 💵 [Donors](#donors) +- 📝 [License](#license) - [Contact](#contact) @@ -115,8 +128,20 @@ And while we have a small team of kind, talented and thoughtful volunteers, we h We abide by our [Code of Conduct](https://owncast.online/contribute/) and feel strongly about open, appreciative, and empathetic people joining us. We’ve been very lucky to have this so far, so maybe you can help us with your skills and passion, too! +If you're new to the project, maybe you'd be interested in looking at [![Good First Issue](https://img.shields.io/github/issues/owncast/owncast/good%20first%20issue.svg)](https://github.com/owncast/owncast/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). + There is a larger, more detailed, and more up-to-date [guide for helping contribute to Owncast on our website](https://owncast.online/help/). +### Donors +The Owncast project is possible thanks to the people who make a donation to support us and our work. +Thank you to all our donors who help keep Owncast running by donating on OpenCollective. You can support this project by [becoming a backer/sponsor](https://opencollective.com/owncast#suppor). + +
+ + GitHub issues by-label + +
+ ## License