README.md in ably-1.0.0 vs README.md in ably-1.0.1
- old
+ new
@@ -300,8 +300,17 @@
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
+## Release notes
+
+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`
+* 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.