README.md in season-0.0.1 vs README.md in season-0.0.2
- old
+ new
@@ -29,29 +29,52 @@
Right now, Season gives you the following helper methods:
```ruby
# You can pass instances of Time/DateTime/String as arguments
-MyModel.created_before(Time.now)
-MyModel.created_after(DateTime.now)
-MyModel.created_between(Time.now - 1.week, '31-01-2015')
+class User < ActiveRecord::Base; end
-MyModel.updated_before(DateTime.now)
-MyModel.updated_after('01-01-2015')
-MyModel.updated_between(Time.now - 1.week, Time.now)
+User.created_before(Time.now)
+User.created_after(DateTime.now)
+User.created_between(Time.now - 1.week, '31-01-2015')
+
+User.updated_before(DateTime.now)
+User.updated_after('01-01-2015')
+User.updated_between(Time.now - 1.week, Time.now)
+```
+
+## Configuration
+
+The scopes are not included by default in your models. To use them you need to include it yourself:
+
+```ruby
+Class User < ActiveRecord::Base
+ include Season::Scopes
+
+ ...
+
+end
+```
+
+If you want them to be available on all of your models by default, add the following code within an initializer - `config/initializers/season.rb`:
+
+```ruby
+Season.configure do |config|
+ config.include_by_default = true
+end
```
## To Do
- Tests!
-- Support other ORMs (Mongoid, <insert-more-here>)
+- Support other ORMs (Mongoid, 'insert-more-here')
- Add Error Handling
- Support user-defined date/time columns (through configuration)
- Support configuration for enabling/disabling Season for all models
## Contributing
-1. Fork it ( https://github.com/[my-github-username]/season/fork )
+1. Fork it ( https://github.com/joaodiogocosta/season/fork )
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 a new Pull Request