diff --git a/.github/workflows/create-documentation-pr.yml b/.github/workflows/create-documentation-pr.yml
new file mode 100644
index 0000000..4d3fb99
--- /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-documentation
+ destination-path: sdks/livestream
+ destination-filename: swift-livestream-library.md
+ pat: "${{ secrets.PAT }}"
+
\ No newline at end of file
diff --git a/README.md b/README.md
index f16367b..e50e70c 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,11 @@
+
[![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-swift-live-stream?style=social)](https://github.com/apivideo/api.video-swift-live-stream) [![badge](https://img.shields.io/discourse/topics?server=https%3A%2F%2Fcommunity.api.video)](https://community.api.video)
![](https://github.com/apivideo/.github/blob/main/assets/apivideo_banner.png)
Swift RTMP live stream client for iOS
[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.
-# Table of contents
+## Table of contents
- [Table of contents](#table-of-contents)
- [Project description](#project-description)
@@ -16,15 +17,28 @@
- [Plugins](#plugins)
- [FAQ](#faq)
-# Project description
+
+
+## Project description
This module is an easy way to broadcast RTMP live stream to [api.video](https://api.video) platform
-# Getting started
+## Getting started
-## Installation
+### Installation
-### Swift Package Manager
+#### Swift Package Manager
In the Project Navigator select your own project. Then select the project in the Project section and click on the Package Dependencies tab. Click on the "+" button at the bottom. Paste the below url on the search bar on the top right. Finaly click on "Add package" button.
@@ -38,7 +52,7 @@ Or add this in your Package.swift
],
```
-### Cocoapods
+#### Cocoapods
1. Add the following entry to your Podfile:
```swift
@@ -47,12 +61,12 @@ pod 'ApiVideoLiveStream', '1.3.5'
2. Then run `pod install`
3. Don’t forget to import `ApiVideoLiveStream` in every file you’d like to use api.video live stream library
-### Carthage
+#### Carthage
```
github "apivideo/ApiVideoLiveStream.swift" ~> 1.3.5
```
-## Permissions
+### Permissions
To be able to broadcast, you must update Info.plist with a usage description for camera and microphone
```xml
@@ -64,7 +78,7 @@ To be able to broadcast, you must update Info.plist with a usage description for
...
```
-## Code sample
+### Code sample
1. In ViewController.swift import the library
```swift
import ApiVideoLiveStream
@@ -92,7 +106,7 @@ liveStream?.startStreaming(streamKey: "YOUR_STREAM_KEY")
```
Alternatively, you can use `startStreaming` `url` parameter to set the URL of your RTMP server.
-# Plugins
+## Plugins
api.video sdk is using external library
@@ -100,7 +114,7 @@ api.video sdk is using external library
| ------ | ------ |
| HaishinKit | [https://github.com/shogo4405/HaishinKit.swift][HaishinKit] |
-# FAQ
+## FAQ
If you have any questions, ask us here: https://community.api.video .
Or use [Issues].