README.md in rubocop-sorbet-0.0.2 vs README.md in rubocop-sorbet-0.1.0

- old
+ new

@@ -1,9 +1,11 @@ -# Rubocop-Sorbet +# Rubocop::Sorbet -A collection of Rubocop rules for Sorbet. +Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rubocop/sorbet`. To experiment with that code, run `bin/console` for an interactive prompt. +TODO: Delete this and the text above, and describe your gem + ## Installation Add this line to your application's Gemfile: ```ruby @@ -12,25 +14,30 @@ And then execute: $ bundle +Or install it yourself as: + + $ gem install rubocop-sorbet + ## Usage -And add this to your `.rubocop.yml` file: +TODO: Write usage instructions here -```yaml -require: - - rubocop-sorbet -``` +## Development +After checking out the repo, run `bin/setup` to install dependencies. Then, run `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`. 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). + ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/rubocop-sorbet. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. +Bug reports and pull requests are welcome on GitHub at https://github.com/paracycle/rubocop-sorbet. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. ## 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 Rubocop::Sorbet project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Shopify/rubocop-sorbet/blob/master/CODE_OF_CONDUCT.md). +Everyone interacting in the Rubocop::Sorbet project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/paracycle/rubocop-sorbet/blob/master/CODE_OF_CONDUCT.md).