diff --git a/README.md b/README.md new file mode 100644 index 0000000..fc86865 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# StreamPack boilerplate Android application + +An example RTMP or SRT live streaming application that demonstrates how to +use [StreamPack](https://github.com/ThibaultBee/StreamPack). In just 5 minutes, you will be able to +stream live video to your server. + +## Features + +- [x] RTMP live streaming +- [x] SRT live streaming +- [x] Zoom on pinch +- [x] Focus on tap + +See [StreamPack](https://github.com/ThibaultBee/StreamPack) for more settings and information. + +## Getting started + +1. Click on "Use this template" to create a new repository from this template. +2. Clone your new repository. +3. Open the project with Android Studio. +4. Set your RTMP or SRT server URL in `MainActivity.kt`. +5. Run the application on a device or an emulator. \ No newline at end of file