README.md in reek-4.0.5 vs README.md in reek-4.1.0

- old
+ new

@@ -438,13 +438,36 @@ ``` bundle exec rake ``` +This will run the tests (RSpec and Cucumber), RuboCop and Reek itself. + +You can also run: + +``` +bundle exec rake ci +``` + +This will run everything the default task runs and also [Ataru](https://github.com/CodePadawans/ataru) and [Mutant](https://github.com/mbj/mutant). This is the task that we run on Travis as well and that determines if your pull request is green or red. + +Another useful Rake task is the `console` task. This will throw you right into an environment where you can play around with Reeks modules and classes: + +``` +bundle exec rake console + +[3] pry(main)> require_relative 'lib/reek/examiner' +=> true +[4] pry(main)> Reek::Examiner +=> Reek::Examiner +``` + +Have a look at our [Developer API](docs/API.md) for more inspiration. + From then on you should check out: + * [How Reek works internally](docs/How-reek-works-internally.md) * [the contributing guide](CONTRIBUTING.md) - If you don't feel like getting your hands dirty with code there are still other ways you can help us: * Open up an [issue](https://github.com/troessner/reek/issues) and report bugs * Suggest other improvements like additional smells for instance