Skip to content

Commit

Permalink
Update development section in readme
Browse files Browse the repository at this point in the history
Publishing v2 showed me that the guidance was generic and incorrect!
  • Loading branch information
mec committed Apr 23, 2024
1 parent 192ffd5 commit 44e5e5e
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,9 +158,13 @@ If you're using ActionMailer with Rails, [previews](https://guides.rubyonrails.o

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec 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
`bin/rspec` to run the tests. 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`. 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).
To release a new version, update the version number in `version.rb`, and then
tag the commit on main - the release will be built and published by the
`publish.yml` GitHub action.

## Contributing

Expand Down

0 comments on commit 44e5e5e

Please sign in to comment.