Skip to content

Commit

Permalink
README to documentation synchro
Browse files Browse the repository at this point in the history
  • Loading branch information
olivier-lando committed Nov 13, 2023
1 parent 13c8b20 commit 592d76b
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 11 deletions.
27 changes: 27 additions & 0 deletions .github/workflows/create-documentation-pr.yml
Original file line number Diff line number Diff line change
@@ -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: swift-livestream-library.md
pat: "${{ secrets.PAT }}"

36 changes: 25 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
<!--<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-swift-live-stream?style=social)](https://github.com/apivideo/api.video-swift-live-stream) &nbsp; [![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)
<h1 align="center">Swift RTMP live stream client for iOS</h1>

[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)
Expand All @@ -16,15 +17,28 @@
- [Plugins](#plugins)
- [FAQ](#faq)

# Project description
<!--</documentation_excluded>-->
<!--<documentation_only>
---
title: Swift live stream library
meta:
description: The official Swift live stream library 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.
---
# Swift Live stream library
[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 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.

Expand All @@ -38,7 +52,7 @@ Or add this in your Package.swift
],
```

### Cocoapods
#### Cocoapods

1. Add the following entry to your Podfile:
```swift
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -92,15 +106,15 @@ 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

| Plugin | README |
| ------ | ------ |
| 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].

Expand Down

0 comments on commit 592d76b

Please sign in to comment.