From b7014c0dbd714311a571dcc578ac0c5817d371e3 Mon Sep 17 00:00:00 2001 From: Cesare Date: Fri, 2 Mar 2018 11:17:25 +0100 Subject: [PATCH 1/4] Add supported platform section to README --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 03285cd036..5bb5b86ba5 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,30 @@ 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 64+ | +|   8 | Firefox 58+ | +|   9   | Safari macOS 11 | +|       | Safari iOS 11 | +|   | Chrome on Android 6| + +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). + +If you find any issues with unsupported platform versions, 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). From 3624f5d151b02c5b0455e9cdb64b2df39a5cd885 Mon Sep 17 00:00:00 2001 From: Cesare Date: Fri, 2 Mar 2018 12:25:44 +0100 Subject: [PATCH 2/4] Add note about fallback mechanisms --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5bb5b86ba5..ab46b73fdb 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,12 @@ A Javascript client library for [Ably Realtime](https://www.ably.io), a realtime 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). - -If you find any issues with unsupported platform versions, 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. + +**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 recent 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. From 8ed2cee5db863ea28d3293df04f1de9751af93b7 Mon Sep 17 00:00:00 2001 From: Cesare Date: Thu, 29 Mar 2018 10:38:55 +0200 Subject: [PATCH 3/4] Update supported browsers --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ab46b73fdb..989779cd02 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,12 @@ A Javascript client library for [Ably Realtime](https://www.ably.io), a realtime | Node.js | Browsers | |----------|--------------------| |   4 | IE 8+     | -|   6 | Chrome 64+ | -|   8 | Firefox 58+ | -|   9   | Safari macOS 11 | -|       | Safari iOS 11 | -|   | Chrome on Android 6| +|   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. From b841e60579a9b719c3cd12e1d40446f83f90f69d Mon Sep 17 00:00:00 2001 From: Cesare Date: Thu, 29 Mar 2018 11:26:34 +0200 Subject: [PATCH 4/4] Update note about browsers --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 989779cd02..5e06851184 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ We do not explicitly maintain compatibility with older platform versions; we no **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 recent browser, on the majority of platforms. +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.