README.md in guard-sass-lint-0.1.1 vs README.md in guard-sass-lint-0.1.2
- old
+ new
@@ -1,41 +1,64 @@
-# Guard::Sass::Lint
+<!--
+
+-->
-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/guard/sass/lint`. To experiment with that code, run `bin/console` for an interactive prompt.
+[](https://gemnasium.com/hansondr/guard-sass-lint)
+[](https://travis-ci.org/hansondr/guard-sass-lint)
-TODO: Delete this and the text above, and describe your gem
+# Guard::Sass::Lint
+**guard-sass-lint** automatically checks your SCSS code style with [sass-lint](https://github.com/sasstools/sass-lint) when files are modified.
+
## Installation
Add this line to your application's Gemfile:
```ruby
-gem 'guard-sass-lint'
+group :development do
+ gem 'guard-sass-lint'
+end
```
And then execute:
- $ bundle
+ $ bundle install
Or install it yourself as:
$ gem install guard-sass-lint
## Usage
-TODO: Write usage instructions here
+Please read the [Guard usage documentation](https://github.com/guard/guard#readme).
-## Development
+## Options
-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.
+You can pass some options in `Guardfile` like the following example:
-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).
+```ruby
+guard :sasslint, run_at_start: true do
+ watch(%r{.+\.scss$})
+end
+```
-## Contributing
+### Available Options
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/guard-sass-lint.
+```ruby
+run_at_start: true # Check all files at Guard startup.
+ # default: false
+config: 'filepath' # Filepath to your sass-lint.yml config
+ # default: sass-lint/docs/sass-lint.yml
+```
+## Contributing
-## License
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+## MIT License
+
+See the [LICENSE.txt](LISCENSE.txt) for details.