Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ricardopereira committed Jan 10, 2019
1 parent de8b07f commit c98cbbe
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 21 deletions.
2 changes: 1 addition & 1 deletion Ably.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Pod::Spec.new do |s|
s.documentation_url = "https://www.ably.io/documentation"
s.ios.deployment_target = '8.0'
s.tvos.deployment_target = '10.0'
s.osx.deployment_target = '10.10'
s.osx.deployment_target = '10.11'
s.requires_arc = true
s.swift_version = '4.2'
s.source_files = 'Source/**/*.{h,m,swift}'
Expand Down
45 changes: 25 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This SDK is compatible with projects that target:

- iOS 8.0+
- tvOS 10.0+
- macOS 10.10+
- macOS 10.11+

We maintain compatibility and explicitly support these platform versions, including performing CI testing on all library revisions.

Expand All @@ -27,15 +27,32 @@ If you find any issues with unsupported platform versions, please [raise an issu
As of version `1.1.2` this library based on the 1.1 library specification. It implements a subset of 1.1 features:
- updated push API and push device authentication;
- support for enforcement of the `maxMessageSize` attribute
Other minor features and bugfixes are included, as listed in the [changelog](CHANGELOG.md#112-2018-11-06).
Other minor features and bugfixes are included, as listed in the [changelog](CHANGELOG.md#113-2019-01-10).

##### ⚠️ macOS
##### macOS & tvOS

The macOS support hasn't been officially released and it's only available from the `mac-support` branch. Please be aware that Push Notifications are currently unsupported. There is a demo available [here](https://github.com/ably/demo-macos).
Please be aware that Push Notifications are currently unsupported. You can only use the [Push Admin](https://www.ably.io/documentation/general/push/admin) functionalities, for example:

##### ⚠️ tvOS
```swift
let recipient: [String: Any] = [
"clientId": "C04BC116-8004-4D78-A71F-8CA3122734DB"
]
let data: [String: Any] = [
"notification": [
"title": "Hello from Ably!",
"body": "Example push notification from Ably."
],
"data": [
"foo": "bar",
"baz": "qux"
]
]
realtime.push.admin.publish(recipient, data: data) { error in
print("Push published:", error ?? "nil")
}
```

The tvOS support hasn't been officially released and it's only available from the `tv-support` branch.
Demos available: [macOS](https://github.com/ably/demo-macos) and [tvOS](https://github.com/ably/demo-tvos).

## Documentation

Expand All @@ -50,13 +67,7 @@ You can install Ably for iOS and macOS through CocoaPods, Carthage or manually.
Add this line to your application's Podfile:

# For Xcode 7.3 and newer
pod 'Ably', '~> 1.0'

# With macOS Support (not officially released)
pod 'Ably', :git => 'https://github.com/ably/ably-ios.git', :branch => 'mac-support'

# With tvOS Support (not officially released)
pod 'Ably', :git => 'https://github.com/ably/ably-ios.git', :branch => 'tv-support'
pod 'Ably', '~> 1.1'

And then install the dependency:

Expand All @@ -67,13 +78,7 @@ And then install the dependency:
Add this line to your application's Cartfile:

# For Xcode 7.3 and newer
github "ably/ably-ios" ~> 1.0

# With macOS Support (not officially released)
github "ably/ably-ios" "mac-support"

# With tvOS Support (not officially released)
github "ably/ably-ios" "tv-support"
github "ably/ably-ios" ~> 1.1

And then run `carthage update` to build the framework and drag the built Ably.framework into your Xcode project.

Expand Down

0 comments on commit c98cbbe

Please sign in to comment.