Update README.md

2022-02-05 21:50:42 -05:00 · 2022-02-05 21:50:42 -05:00 · 24dba4e485
commit 24dba4e485
parent efe18bdbb0
1 changed files with 31 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -1 +1,31 @@
-# Multistream
+![Release](https://img.shields.io/github/v/release/meteoritesolutions/multistream)
+[![Publish Release](https://github.com/meteoritesolutions/multistream/actions/workflows/release.yaml/badge.svg)](https://github.com/meteoritesolutions/multistream/actions/workflows/release.yaml)
+
+# Multistream
+
+## Requirements
+
+- Python 3.9+
+
+- [NGINX](https://nginx.org/) 1.19+
+
+- [NGINX RTMP Module](https://github.com/arut/nginx-rtmp-module)
+
+## Installing
+
+```bash
+pip install multistream
+```
+
+## Usage
+
+Once installed, you can run Multistream with the `multistream` command!
+
+```bash
+# Set directory in which generated config will be placed 
+export NGINX_CONFIG_DIRECTORY="/etc/nginx/conf.d/"
+
+multistream
+```
+
+If everything is configured properly, you'll have a `RTMP` server running on `127.0.0.1`. You can set your streaming software to point at `rtmp://127.0.0.1/livestream` and go LIVE!