README.md in ably-rest-1.1.0 vs README.md in ably-rest-1.1.2.rc1
- old
+ new
@@ -1,19 +1,27 @@
# [Ably](https://www.ably.io)
[](http://badge.fury.io/rb/ably-rest)
-A Ruby REST client library for [www.ably.io](https://www.ably.io), the realtime messaging service.
+A Ruby REST client library for [www.ably.io](https://www.ably.io), the realtime messaging service. This library currently targets the [Ably 1.1 client library specification](https://www.ably.io/documentation/client-lib-development-guide/features/). You can jump to the '[Known Limitations](#known-limitations)' section to see the features this client library does not yet support or [view our client library SDKs feature support matrix](https://www.ably.io/download/sdk-feature-support-matrix) to see the list of all the available features.
## Documentation
Visit https://www.ably.io/documentation for a complete API reference and more examples. The examples and API below is not exhaustive, you should use the completely [Ably API documentation](https://www.ably.io/documentation).
## Realtime vs REST
This REST only library was created for developers who do not want EventMachine as a dependency of their application. Typically developers who are using Ably within their Rails or Sinatra apps would prefer to use the REST library as it has less dependencies and offers a synchronous API.
If however you need to use a realtime library that offers an asynchronous evented AP, then we recommended you [take a look at the combined REST & Realtime gem](https://rubygems.org/gems/ably).
+
+## Known Limitations
+
+This client library is currently *not compatible* with some of the Ably features:
+
+| Feature |
+| :--- |
+| [Custom transportParams](https://www.ably.io/documentation/realtime/connection#client-options) |
## Installation
The client library is available as a [gem from RubyGems.org](https://rubygems.org/gems/ably-rest).