1
0
Fork 0
burden/README.md

39 lines
669 B
Markdown
Raw Normal View History

2013-06-06 18:55:21 +00:00
# Burden
2013-06-04 17:03:30 +00:00
2013-06-06 18:55:21 +00:00
Burden is a tool for managing Rake tasks.
2013-06-04 17:03:30 +00:00
## Installation
Add this line to your application's Gemfile:
2013-06-04 20:41:48 +00:00
```ruby
2013-06-06 18:55:21 +00:00
gem 'burden'
2013-06-04 20:41:48 +00:00
```
2013-06-04 17:03:30 +00:00
And then execute:
2013-06-04 20:41:48 +00:00
```
$ bundle
```
2013-06-04 17:03:30 +00:00
2013-06-04 20:41:48 +00:00
## Configuration
2013-06-04 17:03:30 +00:00
2013-06-04 20:41:48 +00:00
Add this lines to the top of your application's Rakefile:
```ruby
2013-06-06 18:55:21 +00:00
require 'burden'
Burden.configure do |c|
2013-06-04 20:41:48 +00:00
c.storage = :active_record # or :mongoid, :mongo_mapper
end
```
2013-06-04 17:03:30 +00:00
## Usage
2013-06-04 20:41:48 +00:00
stats = Rake::Task['my:task:name'].stats
stats.log
2013-06-04 17:03:30 +00:00
## Contributing
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