README.md in release_image-0.3.1 vs README.md in release_image-0.3.2
- old
+ new
@@ -13,15 +13,15 @@
Enjoy creating eye-catching and unique cover images for your release posts with the Release Image gem!
## Installation
-Install the gem and add it to the application's Gemfile by executing:
+Add this line to your application's Gemfile:
- source "https://rubygems.pkg.github.com/effectivastudio" do
- gem "release_image", require: false
- end
+```ruby
+ gem "release_image", require: false, group: :development
+```
## Usage
Example `bin/release_image` script:
@@ -84,16 +84,14 @@
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake test` 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:local`. 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 the created tag, and push the `.gem` file to [rubygems.pkg.github.com](https://rubygems.pkg.github.com/effectivastudio).
+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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/EffectivaStudio/release_image. 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/EffectivaStudio/release_image/blob/main/CODE_OF_CONDUCT.md).
-
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).