README.md in ably-1.0.4 vs README.md in ably-1.0.5
- old
+ new
@@ -3,10 +3,18 @@
[](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.
+## Supported platforms
+
+This SDK supports Ruby 1.9.3+.
+
+We regression-test the SDK against a selection of Ruby versions (which we update over time, but usually consists of mainstream and widely used versions). Please refer to [.travis.yml](./.travis.yml) for the set of versions that currently undergo CI testing.
+
+If you find any compatibility issues, please [do raise an issue](https://github.com/ably/ably-ruby/issues/new) in this repository or [contact Ably customer support](https://support.ably.io/) for advice.
+
## Documentation
Visit https://www.ably.io/documentation for a complete API reference and more examples.
## Installation
@@ -294,23 +302,25 @@
To see what has changed in recent versions of Bundler, see the [CHANGELOG](CHANGELOG.md).
## Contributing
1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Ensure you have added suitable tests and the test suite is passing(`bundle exec rspec`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+2. When pulling to local, make sure to also pull the `ably-common` repo (`git submodule init && git submodule update`)
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Ensure you have added suitable tests and the test suite is passing(`bundle exec rspec`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create a new Pull Request
-## Release notes
+## Release process
This library uses [semantic versioning](http://semver.org/). For each release, the following needs to be done:
* Update the version number in [version.rb](./lib/ably/version.rb) and commit the change.
* Run [`github_changelog_generator`](https://github.com/skywinder/Github-Changelog-Generator) to automate the update of the [CHANGELOG](./CHANGELOG.md). Once the `CHANGELOG` update has completed, manually change the `Unreleased` heading and link with the current version number such as `v1.0.0`. Also ensure that the `Full Changelog` link points to the new version tag instead of the `HEAD`. Commit this change.
* Add a tag and push to origin such as `git tag v1.0.0 && git push origin v1.0.0`
+* Visit [https://github.com/ably/ably-ruby/tags](https://github.com/ably/ably-ruby/tags) and `Add release notes` for the release including links to the changelog entry.
* Run `rake release` to publish the gem to [Rubygems](http://www.rubydoc.info/gems/ably)
## License
-Copyright (c) 2016 Ably Real-time Ltd, Licensed under the Apache License, Version 2.0. Refer to [LICENSE](LICENSE) for the license terms.
+Copyright (c) 2017 Ably Real-time Ltd, Licensed under the Apache License, Version 2.0. Refer to [LICENSE](LICENSE) for the license terms.