README.md in rake-n-bake-1.1.1 vs README.md in rake-n-bake-1.1.3

- old
+ new

@@ -16,18 +16,31 @@ Rake-n-Bake tasks are used on the project itself, so you can always take a peek at our [Rakefile](https://github.com/RichardVickerstaff/rake-n-bake/blob/master/Rakefile) or the [tasks themselves](https://github.com/RichardVickerstaff/rake-n-bake/tree/master/tasks) to work out what is going on Installation ------------ Either: - 1. Add `gem "rake-n-bake"` to your Gemfile and run bundle install. + - Add `gem "rake-n-bake"` to your Gemfile and run bundle install. + or - 2. Run `gem install rake-n-bake` + - Run `gem install rake-n-bake` + Usage ----- - 1. Add `require "rake_n_bake"` to your Rakefile + 1. Add `require "rake-n-bake"` to your Rakefile 2. Call the tasks that you want, just as with your usual Rake tasks (examples below!). + For example: + ```ruby + task :default => [ + :clean, + :"bake:code_quality:all", + :"bake:rspec", + :"bake:coverage:check_specs", + :"bake:bundler_audit", + :"bake:ok_rainbow", + ] + ``` Tasks ----- Tasks are namespaced under `:bake` to prevent clashes. For example, the `:ok` task is called by invoking `:bake:ok` @@ -70,10 +83,10 @@ ### :ok_rainbow Run this task last to print a more magical version of `:ok` Handy Tips for new tasks ------=------------------ +------------------------ - All tasks loaded by `lib/rake_n_bake.rb` will have access to the `RakeNBake::AssistantBaker`. This is intended for truely common things, like logging out when a particular step runs or passes. Contributing ------------ 1. Make a fork