Skip to content

Commit

Permalink
Clean up README
Browse files Browse the repository at this point in the history
  • Loading branch information
jnraine committed Apr 16, 2018
1 parent 914601f commit 827a403
Showing 1 changed file with 4 additions and 22 deletions.
26 changes: 4 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ I wouldn't recommend adding this to your Gemfile long-term. Rather, try out the

Learn about your Gemfile and see what needs updating.

```
```bash
# Show all out-of-date gems
bundle_report outdated
# Show five oldest, out-of-date gems
Expand Down Expand Up @@ -44,7 +44,7 @@ We don't use MiniTest, so there isn't a prebuilt config for it but I suspect it'

Once you have that, you can start using deprecation tracking in your tests:

```
```bash
# Run your tests and save the deprecations to the shitlist
DEPRECATION_TRACKER=save rspec
# Run your tests and raise an error when the deprecations change
Expand All @@ -55,7 +55,7 @@ DEPRECATION_TRACKER=compare rspec

Once you have stored your deprecations, you can use `deprecations` to display common warnings, run specs, or update the shitlist file.

```
```bash
deprecations info
deprecations info --pattern "ActiveRecord::Base"
deprecations run
Expand All @@ -64,7 +64,6 @@ deprecations --help # For more options and examples

Right now, the path to the shitlist is hardcoded so make sure you store yours at `spec/support/deprecations.shitlist.json`.


### Dual-boot Rails next

This command helps you dual-boot your application.
Expand All @@ -75,6 +74,7 @@ vim Gemfile # Tweak your dependencies conditionally using `next?`
next bundle install # Install new gems
next rails s # Start server using Gemfile.next
```

## Installation

Add this line to your application's Gemfile:
Expand All @@ -91,24 +91,6 @@ Or install it yourself as:

$ gem install ten_years_rails_conf_2018

## Usage

TODO: Write usage instructions here

## 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.

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/[USERNAME]/ten_years_rails_conf_2018. 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 TenYearsRailsConf2018 project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ten_years_rails_conf_2018/blob/master/CODE_OF_CONDUCT.md).

0 comments on commit 827a403

Please sign in to comment.