README.md in dashx-0.2.0 vs README.md in dashx-0.3.0
- old
+ new
@@ -87,12 +87,33 @@
DashX.track('event_name', 'uid_of_user', { hello: 'world' })
```
## Development
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+# Publishing
+
+We use the amazing [gem-release](https://github.com/svenfuchs/gem-release) for releases.
+
+**Installation**
+
+```
+gem install gem-release
+```
+
+**Deploying a new version**
+
+```
+git checkout master // Ensure you're in the master branch
+gem bump -v minor // Automatically sets the version number, commits
+git push origin master // Push the version bump commit
+gem release
+```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/dashxhq/dashx-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/dashxhq/dashx-ruby/blob/master/CODE_OF_CONDUCT.md).