-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3 from AgoraIO/add-license-and-readme
Add license and readme
- Loading branch information
Showing
3 changed files
with
83 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
.DS_Store | ||
/.build | ||
/Packages | ||
/*.xcodeproj | ||
.swiftpm/ | ||
xcuserdata/ | ||
xcshareddata/ | ||
docc_builder | ||
*.xcframework* | ||
docc/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2020 Agora.io Community | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,53 @@ | ||
# Agora Swift Package Manager | ||
|
||
<p align="center"> | ||
<a href="https://docs.agora.io/en/video-calling/overview/product-overview?platform=ios"> | ||
<img src="https://img.shields.io/badge/Documentation-View-F05138?logo=swift"/> | ||
</a> | ||
<a href="https://api-ref.agora.io/en/lite-sdk/ios/4.x/documentation/agorartckit"> | ||
<img src="https://img.shields.io/badge/API%20Reference-View-F05138?logo=swift"/> | ||
</a> | ||
<a href="https://agora-ticket.agora.io"> | ||
<img src="https://img.shields.io/badge/Support-Create%20Ticket-blue?logo=jira"/> | ||
</a> | ||
<br/> | ||
<img src="https://github.com/AgoraIO/AgoraLite_iOS/actions/workflows/swiftpm-resolve.yml/badge.svg"/> | ||
<a href="https://swiftpackageindex.com/AgoraIO/AgoraLite_iOS" style="text-decoration: none;"> | ||
<img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FAgoraIO%2FAgoraLite_iOS%2Fbadge%3Ftype%3Dplatforms"/> | ||
</a> | ||
<a href="https://swiftpackageindex.com/AgoraIO/AgoraLite_iOS"> | ||
<img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FAgoraIO%2FAgoraLite_iOS%2Fbadge%3Ftype%3Dswift-versions"/> | ||
</a> | ||
</p> | ||
|
||
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. | ||
|
||
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). | ||
|
||
 | ||
|
||
## Installation | ||
|
||
To install the Agora Swift Lite SDK, follow these steps: | ||
|
||
1. Open your Xcode project. | ||
2. Go to **File** > **Swift Packages** > **Add Package Dependency**. | ||
3. Paste the following URL of this repository: | ||
|
||
``` | ||
https://github.com/AgoraIO/AgoraLite_iOS | ||
``` | ||
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. | ||
## Troubleshooting | ||
If you encounter any issues during the installation process, try the following steps: | ||
In Xcode, go to File > Swift Packages > Reset Package Caches. | ||
Otherwise [create a ticket](https://agora-ticket.agora.io) and our support team will get back to you ASAP. | ||
--- | ||
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! |