Merge pull request #43 from apivideo/documentation-flutter-live-stream

README to documentation synchro

.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-documentation
+          destination-path: sdks/livestream
+          destination-filename: apivideo-flutter-livestream.md
+          pat: "${{ secrets.PAT }}"
+

README.md

@@ -1,3 +1,4 @@
+<!--<documentation_excluded>-->
 [![badge](https://img.shields.io/twitter/follow/api_video?style=social)](https://twitter.com/intent/follow?screen_name=api_video)
 &nbsp; [![badge](https://img.shields.io/github/stars/apivideo/api.video-flutter-live-stream?style=social)](https://github.com/apivideo/api.video-flutter-live-stream)
 &nbsp; [![badge](https://img.shields.io/discourse/topics?server=https%3A%2F%2Fcommunity.api.video)](https://community.api.video)
@@ -9,28 +10,42 @@
 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)
 - [Getting started](#getting-started)
-    - [Installation](#installation)
-    - [Permissions](#permissions)
-    - [Code sample](#code-sample)
+  - [Installation](#installation)
+  - [Permissions](#permissions)
+  - [Code sample](#code-sample)
+    - [Manage application lifecycle](#manage-application-lifecycle)
 - [Example App](#example-app)
-    - [Setup](#setup)
-        - [Android](#android)
-        - [iOS](#ios)
+  - [Setup](#setup)
+    - [Android](#android)
+    - [iOS](#ios)
 - [Plugins](#plugins)
 - [FAQ](#faq)
 
-# Project description
+<!--</documentation_excluded>-->
+<!--<documentation_only>
+---
+title: Flutter RTMP live stream client
+meta: 
+  description: The official Flutter RTMP live stream client for api.video. [api.video](https://api.video/) is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.
+---
+
+# Flutter RTMP Live stream Client
+
+[api.video](https://api.video/) is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.
+
+</documentation_only>-->
+## Project description
 
 This module is made for broadcasting RTMP live stream from smartphone camera.
 
-# Getting started
+## Getting started
 
-## Installation
+### Installation
 
 In your pubspec.yaml file, add the following:
 
@@ -45,7 +60,7 @@ In your dart file, import the package:
 import 'package:apivideo_live_stream/apivideo_live_stream.dart';
 ```
 
-## Permissions
+### Permissions
 
 To be able to broadcast, you must:
 
@@ -71,7 +86,7 @@ The library will require android.permission.CAMERA and android.permission.RECORD
 <key>NSMicrophoneUsageDescription</key><string>Your own description of the purpose</string>
 ```
 
-## Code sample
+### Code sample
 
 1. Creates a live stream controller
 
@@ -107,7 +122,7 @@ _controller.startStreaming("YOUR_STREAM_KEY");
 _controller.stop();
 ```
 
-### Manages application lifecycle
+#### Manage application lifecycle
 
 On the application side, you must manage application lifecycle:
 
@@ -122,13 +137,13 @@ void didChangeAppLifecycleState(AppLifecycleState state) {
 }
 ```
 
-# Example App
+## Example App
 
 You can try
 our [example app](https://github.com/apivideo/api.video-flutter-live-stream/tree/master/example),
 feel free to test it.
 
-## Setup
+### Setup
 
 Be sure to follow the [Flutter installation steps](https://docs.flutter.dev/get-started/) before
 anything.
@@ -144,11 +159,11 @@ [email protected]:apivideo/api.video-flutter-live-stream.git
 
 Wait for the indexation to finish.
 
-### Android
+#### Android
 
 Connect an Android device to your computer and click on the `Run main.dart` button.
 
-### iOS
+#### iOS
 
 1) Connect an iOS device to your computer and click on the `Run main.dart` button.
 
@@ -159,7 +174,7 @@ the `YOUR_PROJECT_NAME/example/ios/Runner.xcworkspace` file.
 <br />Click on Example, go in `Signin & Capabilities` tab, add your team and create a unique bundle
 identifier.
 
-# Plugins
+## Plugins
 
 api.video Flutter live stream library is using external native library:
 
@@ -168,7 +183,7 @@ api.video Flutter live stream library is using external native library:
 | StreamPack | [StreamPack] |
 | HaishinKit | [HaishinKit] |
 
-# FAQ
+## FAQ
 
 If you have any questions, ask us in the [community](https://community.api.video). Or
 use [issues](https://github.com/apivideo/api.video-flutter-live-stream/issues).