Skip to content

Commit

Permalink
Spell checked documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@Cartisim
Cartisim committed Aug 30, 2023
1 parent 12c4e8b commit e552289
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 25 deletions.
30 changes: 15 additions & 15 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,16 @@

**Important Notice**

While out SDK may work on older operating systems we only support the system minimum requirements. The system minimum requirements indicate what is available on the current latest release. Each release is cut at a commit of our SDK. That commit may support other system minimum version requirements. We do make changes to older versions. We improve and support on top of the latest version released.
While our SDK may work on older operating systems, we only support the system minimum requirements. The system minimum requirements indicate what is available on the current latest release. Each release is cut at a commit of our SDK. That commit may support other system minimum version requirements. We do not make changes to older versions. We improve and support on top of the latest version released.


Applications developed with FCSDKiOS are compatible on operating systems running iOS 14 and later. Due to our operating system availability restrictions on devices that support iOS 14 and greater can be used.
Applications developed with FCSDKiOS are compatible on operating systems running iOS 14 and later. Due to our operating system availability, restrictions on devices that support iOS 14 and greater can be used.

You may see different specs located in the `Package.swift` file or the `FCSDKiOS.podspec`. This does not mean we support a lower operating system. This is allowed in order to allow applications to import our SDK, but not use it at compile or run time with the appropriate checks in the applications code base. Some applications may wish to support older operating systems and only use FCSDKiOS if the application running it is an approved operating system.

If you are having issues on an unsupported operating system please either upgrade you application's minimum verion or disclude the SDK on the said version.
If you are having issues on an unsupported operating system, please either upgrade you application's minimum verion or exclude the SDK on the said version.

#### Please Follow this repository for the latest SDK notifications.
#### Please follow this repository for the latest SDK notifications.


## Documentation
Expand All @@ -46,7 +46,7 @@ We are happy to introduce *DocC* documentation for SwiftFCSDKiOS. Simply build t
[Version 4.1.0 ](https://github.com/cbajapan/swift-fcsdk-ios/blob/main/Sources/SwiftFCSDKiOS/SwiftFCSDKiOS.docc/Version-4.1.0.md 'Version 4.1.0')

## Getting Started
**Please Read our DocC Documentation for more information**
**Please read our DocC Documentation for more information**

[Getting Started](https://github.com/cbajapan/fcsdk-ios/blob/main/Sources/SwiftFCSDKiOS/SwiftFCSDKiOS.docc/GettingStarted.md 'Getting Started')

Expand All @@ -70,7 +70,7 @@ We are happy to introduce *DocC* documentation for SwiftFCSDKiOS. Simply build t

1. In your Xcode Project, select File > Swift Packages > Add Package Dependency.
2. Follow the prompts using the URL for this repository
3. Choose which version you would like to checkout(i.e. 4.0.0-beta.1.0)
3. Choose which version you would like to check out (i.e. 4.0.0-beta.1.0)
4. Make sure the binary is linked in your Xcode Project via the target ``Target -> Build Phases -> Linked Binary``.

If you want to depend on FCSDKiOS in your own project using SPM, it's as simple as adding a `dependencies` clause to your `Package.swift`:
Expand All @@ -82,7 +82,7 @@ dependencies: [
]
```

There at times may be some struggles updating **FCSDKiOS** versions or resolving the package due to Xcode and SPM caching the Package, this is normal behavior in iOS development with BinaryTargets in a SwiftPackage. Here is a list of trouble shooting steps you may follow.
There may be some struggles updating **FCSDKiOS** versions or resolving the package due to Xcode and SPM caching the Package at times, this is normal behavior in iOS development with BinaryTargets in a SwiftPackage. Here is a list of trouble shooting steps you may follow.

Under File -> Packages. you will find 3 options
* Reset Package Cache
Expand All @@ -92,9 +92,9 @@ Under File -> Packages. you will find 3 options
It is always a good idea to -
1. Clean the build folder
2. *Resolve Package Versions*
3. If that fails then *Reset Package Cache*
3. If that fails, then *Reset Package Cache*

While Updating the version if you rin into similar issues try and...
While Updating the version if you run into similar issues try and...
1. Clean the build folder
2. *Update Package Versions*

Expand All @@ -106,14 +106,14 @@ If you still have issues then -
5. Open Xcode
6. Re-add FCSDKiOS

**It is important to note that if yoour project has a compiler error stating that it cannot find the Module, then you should make sure that the package is linked in the App's Target's Build Phases section.**
**It is important to note that if your project has a compiler error stating that it cannot find the Module, then you should make sure that the package is linked in the App's Target's Build Phases section.**


## CocoaPods ##

Starting in version 4.2.0 of FCSDKiOS we are supporting CocoaPods as a delivery mechanism.

In order to use our CocoaPod please follow the following instructions.
In order to use our CocoaPod, please follow the following instructions.

1. Navigate to your project
2. Run `pod init`
Expand All @@ -134,19 +134,19 @@ end
```
5. Close the Podfile
6. Run `pod install`
7. You now will use the **.xcworkspace** instead of **.xcodeproj** as a project source.
7. You will now use the **.xcworkspace** instead of **.xcodeproj** as a project source.

**NOTE:** if you have trouble installing or updating the CocoaPod, you may have an issue with the local pod repo.
**NOTE:** If you have trouble installing or updating the CocoaPod, you may have an issue with the local pod repo.

*If that is the case please try running the following Pod Commands*
*If that is the case, please try running the following Pod Commands*

```
sudo rm -rf ~/.cocoapods/repos/cbajapan-swift-fcsdk-ios
pod setup
pod install
```

Afterwards you can run the install or update command again
Afterwards, you can run the install or update command again

```
pod install
Expand Down
20 changes: 10 additions & 10 deletions Sources/SwiftFCSDKiOS/SwiftFCSDKiOS.docc/Version-4.2.5.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ This article describes changes in version 4.2.5 of FCSDKiOS

Version 4.2.5 has several bug fixes and performance improvements. Below is a list of bug fixes.

### We fixed an issue where setting the ACBClientCallDelegate may not have been setting.
### We fixed an issue where setting the ACBClientCallDelegate may not have been set.

### Ensursing that when a new view is fed to the SDK's remote and local views they are created properly.
### Ensuring that when a new view is fed to the SDK's remote and local views they are created properly.

### Fixed an issue where iOS 13 users may not have been connecting to the socket.

Expand All @@ -20,7 +20,7 @@ Version 4.2.5 has several bug fixes and performance improvements. Below is a lis

### Introduced and Deprecated methods that should be called from an Async Context in order to protect synchronization of state.

## Below is a list of methods where the synchronous methods were deprecated and we request you to use the listed async versions bellow
## Below is a list of methods where the synchronous methods were deprecated and we request you to use the listed async versions below

```swift
await call.enableLocalVideo(false)
Expand Down Expand Up @@ -48,25 +48,25 @@ _ = await acbuc.phone.recommendedCaptureSettings()
*`.horizontal`*
The horizontal scale mode is designed to scale the content with it's aspect ratio to the widest point. This means if your view is too short in relationship with the aspect ratio than it will clip the height of the content. If the view is too tall then you will see back space on the top and bottom of the views content.
The horizontal scale mode is designed to scale the content with its aspect ratio to the widest point. This means if your view is too short in relationship with the aspect ratio, then it will clip the height of the content. If the view is too tall, then you will see black space on the top and bottom of the view's content.
*`.vertical`*
The vertical scale mode is designed to scale the content with it's aspect ratio to the tallest point. This means if your view is too narrow in relationship with the aspect ratio than it will clip the width of the content. If the view is too wide then you will see back space on the left and right of the views content.
The vertical scale mode is designed to scale the content with its aspect ratio to the tallest point. This means if your view is too narrow in relationship with the aspect ratio, then it will clip the width of the content. If the view is too wide, then you will see black space on the left and right of the view's content.
*`.fill`*
The fill scale mode is designed to scale the content to fill the view's container with it's aspect ratio. This means the view will clip both height and width of the content in order to fill the view.
The fill scale mode is designed to scale the content to fill the view's container with its aspect ratio. This means the view will clip both height and width of the content in order to fill the view.
*`.none`*
The none scale mode feeds the raw data into the view with out any scaling.
The none scale mode feeds the raw data into the view without any scaling.
**`shouldScaleWithOrientation`**
This boolean property is intended for use when the scale mode is set to *.vertical* or *.horizontal*. For instance you may want to start out a call in .vertical mode for both `localBufferView` and `remoteBufferView`, however when a device rotates you may then want to scale to the opposite longest point *i.e.* `.horizontal` mode. Setting this parameter to true will give you this behavior.
This boolean property is intended for use when the scale mode is set to *.vertical* or *.horizontal*. For instance you may want to start out a call in `.vertical` mode for both `localBufferView` and `remoteBufferView`, however when a device rotates, you may then want to scale to the opposite longest point *i.e.* `.horizontal` mode. Setting this parameter to true will give you this behavior.
**Here is what these properties look like in use**
**Here are what these properties look like in use**
```swift
remoteBufferView(
Expand All @@ -81,4 +81,4 @@ localBufferView(
```

These API's provide you with a truly customizable approach in your applications.
These APIs provide you with a truly customizable approach in your applications.

0 comments on commit e552289

Please sign in to comment.