Merge pull request #73 from AgoraIO-Community/docc-update

DocC Update on SPI

.spi.yml

@@ -0,0 +1,5 @@
+version: 1
+builder:
+  configs:
+    - platform: ios
+      documentation_targets: [AgoraUIKit]

AgoraRtmControl_iOS.podspec

@@ -9,7 +9,7 @@
 Pod::Spec.new do |s|
   s.name             = 'AgoraRtmControl_iOS'
   s.module_name      = 'AgoraRtmControl'
-  s.version          = ENV['LIB_VERSION'] || '1.8.2'
+  s.version          = ENV['LIB_VERSION'] || '1.8.3'
   s.summary          = 'Agora Real-time Messaging Wrapper.'
 
   s.description      = <<-DESC

AgoraRtmControl_macOS.podspec

@@ -9,7 +9,7 @@
 Pod::Spec.new do |s|
   s.name             = 'AgoraRtmControl_macOS'
   s.module_name      = 'AgoraRtmControl'
-  s.version          = ENV['LIB_VERSION'] || '1.8.2'
+  s.version          = ENV['LIB_VERSION'] || '1.8.3'
   s.summary          = 'Agora Real-time Messaging Wrapper.'
 
   s.description      = <<-DESC

AgoraUIKit_iOS.podspec

@@ -9,7 +9,7 @@
 Pod::Spec.new do |s|
   s.name             = 'AgoraUIKit_iOS'
   s.module_name      = 'AgoraUIKit'
-  s.version          = ENV['LIB_VERSION'] || '1.8.2'
+  s.version          = ENV['LIB_VERSION'] || '1.8.3'
   s.summary          = 'Agora video session UIKit template.'
 
   s.description      = <<-DESC

AgoraUIKit_macOS.podspec

@@ -9,7 +9,7 @@
 Pod::Spec.new do |s|
   s.name             = 'AgoraUIKit_macOS'
   s.module_name      = 'AgoraUIKit'
-  s.version          = ENV['LIB_VERSION'] || '1.8.2'
+  s.version          = ENV['LIB_VERSION'] || '1.8.3'
   s.summary          = 'Agora video session AppKit template.'
 
   s.description      = <<-DESC

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.4
+// swift-tools-version:5.5
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription

Sources/Agora-UIKit/AgoraUIKit.swift

@@ -22,7 +22,7 @@ public struct AgoraUIKit: Codable {
     /// Framework type of UIKit. "native", "flutter", "reactnative"
     fileprivate(set) var framework: String
     /// Version of UIKit being used
-    static let version = "1.8.2"
+    static let version = "1.8.3"
     /// Framework type of UIKit. "native", "flutter", "reactnative"
     static let framework = "native"
     #if os(iOS)

Sources/Agora-UIKit/Documentation.docc/AgoraUIKit.md

@@ -0,0 +1,25 @@
+# ``AgoraUIKit``
+
+Integrate Agora Video Calling or Live Video Streaming to your iOS or macOS app with just a few lines of code.
+
+## Overview
+
+Agora UIKit is a low-code solution to adding video calls and live streams into your application.
+
+Get started with this package by creating an ``AgoraVideoViewer`` and joining a channel:
+
+```swift
+import AgoraRtcKit
+import AgoraUIKit
+
+let agoraView = AgoraVideoViewer(
+    connectionData: AgoraConnectionData(
+        appId: "<#my-app-id#>",
+        rtcToken: "<#my-channel-token#>",
+        rtmToken: "<#my-channel-rtm-token#>"
+    ), delegate: self
+)
+
+agoraView.join(channel: "test", as: .broadcaster)
+
+```

Sources/AgoraRtmControl/Documentation.docc/AgoraRtmControl.md

@@ -0,0 +1,7 @@
+# ``AgoraRtmControl``
+
+AgoraRtmControl is a light wrapper around the Agora RTM.
+
+## Overview
+
+This wrapper keeps track of active channels and other users in the same channel as you.