Skip to content

Commit 78ddf72

Browse files
authored
Merge pull request #3 from AgoraIO/add-license-and-readme
Add license and readme
2 parents bb66725 + cefcf3c commit 78ddf72

File tree

3 files changed

+83
-0
lines changed

3 files changed

+83
-0
lines changed

.gitignore

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.DS_Store
2+
/.build
3+
/Packages
4+
/*.xcodeproj
5+
.swiftpm/
6+
xcuserdata/
7+
xcshareddata/
8+
docc_builder
9+
*.xcframework*
10+
docc/

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 Agora.io Community
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

readme.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,53 @@
1+
# Agora Swift Package Manager
12

3+
<p align="center">
4+
<a href="https://docs.agora.io/en/video-calling/overview/product-overview?platform=ios">
5+
<img src="https://img.shields.io/badge/Documentation-View-F05138?logo=swift"/>
6+
</a>
7+
<a href="https://api-ref.agora.io/en/lite-sdk/ios/4.x/documentation/agorartckit">
8+
<img src="https://img.shields.io/badge/API%20Reference-View-F05138?logo=swift"/>
9+
</a>
10+
<a href="https://agora-ticket.agora.io">
11+
<img src="https://img.shields.io/badge/Support-Create%20Ticket-blue?logo=jira"/>
12+
</a>
13+
<br/>
14+
<img src="https://github.com/AgoraIO/AgoraLite_iOS/actions/workflows/swiftpm-resolve.yml/badge.svg"/>
15+
<a href="https://swiftpackageindex.com/AgoraIO/AgoraLite_iOS" style="text-decoration: none;">
16+
<img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FAgoraIO%2FAgoraLite_iOS%2Fbadge%3Ftype%3Dplatforms"/>
17+
</a>
18+
<a href="https://swiftpackageindex.com/AgoraIO/AgoraLite_iOS">
19+
<img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FAgoraIO%2FAgoraLite_iOS%2Fbadge%3Ftype%3Dswift-versions"/>
20+
</a>
21+
</p>
22+
23+
Welcome to the Agora Swift Lite SDK! This package allows you to integrate powerful video capabilities into your iOS applications. You have the flexibility to choose from a variety of extensions to enhance your video communication experience.
24+
25+
For a complete understanding of how to use the SDK and its various extensions, please refer to the [full documentation](https://docs.agora.io/en/video-calling/overview/product-overview?platform=ios).
26+
27+
![](media/swiftpm-agora.png)
28+
29+
## Installation
30+
31+
To install the Agora Swift Lite SDK, follow these steps:
32+
33+
1. Open your Xcode project.
34+
2. Go to **File** > **Swift Packages** > **Add Package Dependency**.
35+
3. Paste the following URL of this repository:
36+
37+
```
38+
https://github.com/AgoraIO/AgoraLite_iOS
39+
```
40+
4. Xcode will offer you a choice of products to add. Make sure to select **`RtcBasic`** for core functionality and choose any other extensions you require.
41+
42+
43+
## Troubleshooting
44+
45+
If you encounter any issues during the installation process, try the following steps:
46+
47+
In Xcode, go to File > Swift Packages > Reset Package Caches.
48+
49+
Otherwise [create a ticket](https://agora-ticket.agora.io) and our support team will get back to you ASAP.
50+
51+
---
52+
53+
Feel free to explore and utilize the wide range of features provided by the Agora Swift Lite SDK to create immersive and engaging video experiences in your application!

0 commit comments

Comments
 (0)