README.md in encx-0.1.0 vs README.md in encx-0.1.3

- old
+ new

@@ -4,36 +4,34 @@ TODO: Delete this and the text above, and describe your gem ## Installation -Add this line to your application's Gemfile: +Install the gem and add to the application's Gemfile by executing: -```ruby -gem 'encx' -``` + $ bundle add encx -And then execute: +If bundler is not being used to manage dependencies, install the gem by executing: - $ bundle - -Or install it yourself as: - $ gem install encx ## Usage TODO: Write usage instructions here ## Development -After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec encx` to use the code located in this directory, ignoring other installed copies of this gem. +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. -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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). +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 -1. Fork it ( https://github.com/[my-github-username]/encx/fork ) -2. Create your feature branch (`git checkout -b my-new-feature`) -3. Commit your changes (`git commit -am 'Add some feature'`) -4. Push to the branch (`git push origin my-new-feature`) -5. Create a new Pull Request +Bug reports and pull requests are welcome on GitHub at https://github.com/ykominami/encx. 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/ykominami/encx/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). + +## Code of Conduct + +Everyone interacting in the Encx project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ykominami/encx/blob/main/CODE_OF_CONDUCT.md).