Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add supported platform section to README #481

Merged
merged 4 commits into from
Apr 5, 2018
Merged

Add supported platform section to README #481

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b7014c0
Add supported platform section to README
funkyboy Mar 2, 2018
3624f5d
Add note about fallback mechanisms
funkyboy Mar 2, 2018
8ed2cee
Update supported browsers
funkyboy Mar 29, 2018
b841e60
Update note about browsers
funkyboy Mar 29, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,35 @@

A Javascript client library for [Ably Realtime](https://www.ably.io), a realtime data delivery platform.

## Supported platforms

This SDK is compatible with the following platforms:

| Node.js | Browsers |
|----------|--------------------|
|   4 | IE 8+     |
|   6 | Chrome 56+ |
|   8 | Firefox 51+ |
|   9   | Safari 10+ macOS |
|       | Safari 10+ iOS |
|         | Opera 41+       |
|   | Chrome Android 4+ |

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

We do not explicitly maintain compatibility with older platform versions; we no longer perform CI testing on iOS7 as of version 1.0.13 (released on February 2nd 2018). Any known incompatibilities with older versions can be found [here](https://github.com/ably/ably-js/issues?q=is%3Aissue+is%3Aopen+label%3A%22compatibility%22).

**Note**: the ably-js browser library contains fallback mechanisms in order to be able to support older browsers; specifically it supports comet-based connections for browsers that do not support websockets, and this includes JSONP for browsers that do not support cross-origin XHR.
Each of these fallback transport mechanisms is supported and tested on all of the listed target browsers; even when those browsers do not themselves require those fallbacks.
These mean that the library should be compatible with nearly any browser, on the majority of platforms.

If, however, you do find compatibility issues with any specific platform and browser combination, please [raise an issue](https://github.com/ably/ably-js/issues) in this repository or [contact Ably customer support](https://support.ably.io) for advice.

We also support React Native, NativeScript and TypeScript. See below for more details.

## Version: 1.0.13

This repo contains the Ably Javascript client library, for the browser (including IE8+), Nodejs, React Native, NativeScript and Cordova.
The latest stable version of the Ably Javascript client library is `1.0.13`.

For complete API documentation, see the [Ably documentation](https://www.ably.io/documentation).

Expand Down