README.md in guard-reek-0.0.4 vs README.md in guard-reek-1.0.1
- old
+ new
@@ -1,25 +1,63 @@
-Guard::Reek [](https://travis-ci.org/gvillalta99/guard-reek) [](https://coveralls.io/r/gvillalta99/guard-reek) [](https://codeclimate.com/github/gvillalta99/guard-reek)
-=========================
-TODO: Write a gem description
+[](http://badge.fury.io/rb/guard-reek)
+[](https://travis-ci.org/my-grocery-price-book/guard-reek)
+# guard-reek
+
+**guard-reek** allows you to automatically detect code smells with [Reek](https://github.com/troessner/reek) when files are modified.
+
## Installation
-Add this line to your application's Gemfile:
+Please make sure to have [Guard](https://github.com/guard/guard) installed before continue.
- gem 'guard-reek'
+Add `guard-reek` to your `Gemfile`:
-And then execute:
+```ruby
+group :development do
+ gem 'guard-reek'
+end
+```
- $ bundle
+and then execute:
-Or install it yourself as:
+```sh
+$ bundle install
+```
- $ gem install guard-reek
+or install it yourself as:
+```sh
+$ gem install guard-reek
+```
+
+Add the default Guard::Reek definition to your `Guardfile` by running:
+
+```sh
+$ guard init reek
+```
+
## Usage
-TODO: Write usage instructions here
+Please read the [Guard usage documentation](https://github.com/guard/guard#readme).
+
+## Options
+
+You can pass some options in `Guardfile` like the following example:
+
+```ruby
+guard :reek, all_on_start: false, run_all: false do
+ # ...
+end
+```
+
+### Available Options
+
+```
+all_on_start: true # Check all files at Guard startup.
+ # default: true
+run_all: true # Check all files on "Enter"
+ # default: true
+```
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)