Skip to content

Commit

Permalink
README Updates (#1)
Browse files Browse the repository at this point in the history
* Docs link added to README, instructions for when swiftpm fails
* package resolve GitHub Action
* GitHub Action badge added to README
  • Loading branch information
maxxfrazer authored Jun 23, 2021
1 parent 7a2c272 commit a0e0b01
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
19 changes: 19 additions & 0 deletions .github/workflows/swiftpm-resolve.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: resolve

on:
push:
branches:
- "main"
tags:
- "!*"
pull_request:
branches:
- "*"

jobs:
resolve:
runs-on: macOS-latest
steps:
- uses: actions/checkout@v1
- name: Build Package
run: swift package resolve
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
# Agora Swift Package Manager

<p align="center">
<img src="https://github.com/AgoraIO/AgoraRtcEngine_iOS/actions/workflows/swiftpm-resolve.yml/badge.svg"/>
</p>

Install Agora Video SDK easily with Swift Package Manager.

[Click here for full documentation](https://docs.agora.io/en/Video/landing-page?platform=iOS).

## Installation

Add the URL of this repository to your Xcode 11+ Project.
Expand All @@ -10,3 +16,8 @@ Go to File > Swift Packages > Add Package Dependency, and paste in the link to t

`https://github.com/AgoraIO/AgoraRtcEngine_iOS`

---

If you have issues installing this Swift Package:

In Xcode's File menu, select 'Swift Packages' and then 'Reset Package Caches'.

0 comments on commit a0e0b01

Please sign in to comment.