Skip to content

Commit 477b68c

Browse files
committed
Added installation guide to README for both Xcode and Swift Package Manager
1 parent 04c659a commit 477b68c

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,29 @@ This SDK supports the following platforms:
4040
4141
---
4242

43+
## Installation
44+
45+
The SDK is distributed as a Swift Package and can be installed using Xcode or by adding it as a dependency in your package's `Package.swift`.
46+
47+
#### Using Xcode
48+
49+
To install the `ably-chat-swift` package in your Xcode Project:
50+
51+
1. Open your Xcode project and navigate to **File → Add Package Dependencies...**
52+
2. Paste `https://github.com/ably/ably-chat-swift` in the search box
53+
3. Select the version you want to use
54+
4. Select the Ably Chat SDK for your target
55+
56+
#### Using Swift Package Manager
57+
58+
To install the `ably-chat-swift` package in another Swift Package, add the following to your `Package.swift`:
59+
60+
```swift
61+
.package(url: "https://github.com/ably/ably-chat-swift", from: "1.1.0"),
62+
```
63+
64+
---
65+
4366
## Usage
4467

4568
The following code connects to Ably's chat service, subscribes to a chat room, and sends a message to that room:

0 commit comments

Comments
 (0)