README.md
# Guard::Flog [![Dependency Status](https://gemnasium.com/pericles/guard-flog.png)](https://gemnasium.com/pericles/guard-flog) [![Code Climate](https://codeclimate.com/github/pericles/guard-flog.png)](https://codeclimate.com/github/pericles/guard-flog)
Flog guard flogs every file on change.
* Compatible with Bundler 1.0.x
## Install
Please be sure to have [Guard](https://github.com/guard/guard) installed before continue.
Add it to your Gemfile (inside development group):
``` ruby
group :development do
gem 'guard-flog'
end
```
Add guard definition to your Guardfile by running this command:
```
$ guard init flog
```
## Usage
Please read [Guard usage doc](https://github.com/guard/guard#readme)
## Guardfile
```ruby
guard :flog do
watch(%r{^lib/(.+)\.rb$})
# Rails example
watch(%r{^app/(.+)\.rb$})
end
```
Please read [Guard doc](https://github.com/guard/guard#readme) for more information about the Guardfile DSL.
## TODO
* Tests
* Notifications
* Guard params
## Development
* Source hosted at [GitHub](https://github.com/pericles/guard-flog)
* Report issues/Questions/Feature requests on [GitHub Issues](https://github.com/pericles/guard-flog/issues)
Pull requests are very welcome! Make sure your patches are well tested. Please create a topic branch for every separate change
you make.
## Authors
[PĂ©ricles Dias](https://github.com/pericles)