Known limitations section in README #177
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mattheworiordan
requested changes
Feb 14, 2019
README.md
Outdated
| @@ -3,7 +3,7 @@ | |||
| [](http://badge.fury.io/rb/ably) | |||
| [](https://coveralls.io/r/ably/ably-ruby) | |||
|
|
|||
| A Ruby client library for [ably.io](https://www.ably.io), the realtime messaging service. | |||
| A Ruby client library for [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 visit the [Feature Support Matrix](https://www.ably.io/feature-support-matrix) to see the list of all the available features. | |||
There was a problem hiding this comment.
Can we please make the URL reflect the context i.e. something like https://www.ably.io/download/sdk-feature-support-matrix?
README.md
Outdated
|
|
||
| | Feature | Spec reference | | ||
| | :--- | :--- | | ||
| | Custom transportParams | [RTC1f](https://ably.io/documentation/client-lib-development-guide/features/#RTC1f) | |
There was a problem hiding this comment.
Please link to the actual docs, and do not use ably.io, our URLs are www.ably.io. Also, one column is fine, see ably/ably-go@ff53376
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please note that the spec item currently links to the staging site as on the main website, the individual spec items can't be linked. I have raised an issue, however: https://github.com/ably/website/issues/2126