diff --git a/README.md b/README.md index 2a30e6a..1c4d4b4 100644 --- a/README.md +++ b/README.md @@ -77,9 +77,40 @@ end ## 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 -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. +```sh +bundle install +``` + +Then, run + +```sh +rake spec +``` +to run the tests. + +To install this gem onto your local machine, run + +```sh +bundle exec rake install +``` + +To release a new version, update the version number in version.rb, and then run + +```sh +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. + +To use this locally during development, I like to include it whatever project I'm working by adding the following to the `Gemfile` of the other project + +```ruby +gem "rrf", path: '/what/ever/path/you/choose/rrf' +``` + +Then bundle and it will use your development copy. ## Contributing