diff --git a/.github/workflows/create-documentation-pr.yml b/.github/workflows/create-documentation-pr.yml new file mode 100644 index 0000000..3b3d82a --- /dev/null +++ b/.github/workflows/create-documentation-pr.yml @@ -0,0 +1,27 @@ +name: Create documentation PR +on: + # Trigger the workflow on pull requests targeting the main branch + pull_request: + types: [assigned, unassigned, opened, reopened, synchronize, edited, labeled, unlabeled, edited, closed] + branches: + - main + +jobs: + create_documentation_pr: + if: github.event.action != 'closed' + + runs-on: ubuntu-latest + + steps: + - name: Check out current repository code + uses: actions/checkout@v2 + + - name: Create the documentation pull request + uses: apivideo/api.video-create-readme-file-pull-request-action@main + with: + source-file-path: "README.md" + destination-repository: apivideo/api.video-api-client-generator + destination-path: templates/documentation/sdks/livestream + destination-filename: apivideo-android-livestream-module.md + pat: "${{ secrets.PAT }}" + \ No newline at end of file diff --git a/README.md b/README.md index 38ff536..54e9bd1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ + [![badge](https://img.shields.io/twitter/follow/api_video?style=social)](https://twitter.com/intent/follow?screen_name=api_video)   [![badge](https://img.shields.io/github/stars/apivideo/api.video-android-live-stream?style=social)](https://github.com/apivideo/api.video-android-live-stream)   [![badge](https://img.shields.io/discourse/topics?server=https%3A%2F%2Fcommunity.api.video)](https://community.api.video) @@ -8,7 +9,7 @@ video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app. -# Table of contents +## Table of contents - [Table of contents](#table-of-contents) - [Project description](#project-description) @@ -22,15 +23,28 @@ your app. - [Sample application](#sample-application) - [FAQ](#faq) -# Project description + + +## Project description This library is an easy way to broadcast livestream to api.video platform on Android. -# Getting started +## Getting started -## Installation +### Installation -### Gradle +#### Gradle On build.gradle add the following code in dependencies: @@ -40,7 +54,7 @@ dependencies { } ``` -## Permissions +### Permissions ```xml @@ -54,7 +68,7 @@ dependencies { Your application must dynamically require `android.permission.CAMERA` and `android.permission.RECORD_AUDIO`. -## Code sample +### Code sample 1. Add [permissions](#permissions) to your `AndroidManifest.xml` and request them in your Activity/Fragment. @@ -126,16 +140,16 @@ class MyFragment : Fragment(), ConnectionChecker { For detailed information on this livestream library API, refers to [API documentation](https://apivideo.github.io/api.video-android-live-stream/). -# Tips +## Tips You can check device supported configurations by using the helper: `Helper` -# Documentation +## Documentation * [API documentation](https://apivideo.github.io/api.video-android-live-stream/) * [api.video documentation](https://docs.api.video) -# Dependencies +## Dependencies We are using external library @@ -143,11 +157,11 @@ We are using external library | ------ | ------ | | [StreamPack](https://github.com/ThibaultBee/StreamPack) | [README.md](https://github.com/ThibaultBee/StreamPack/blob/master/README.md) | -# Sample application +## Sample application A demo application demonstrates how to use this livestream library. See `/example` folder. -# FAQ +## FAQ If you have any questions, ask us here: https://community.api.video . Or use [Issues].