README.md in mongoid-report-0.0.6 vs README.md in mongoid-report-0.0.7
- old
+ new
@@ -1,10 +1,14 @@
# Mongoid Report
Library for easy building aggregation report using mongodb aggregation
framework.
+[![Build Status](https://secure.travis-ci.org/oivoodoo/mongoid-report.png?branch=master)](https://travis-ci.org/oivoodoo/mongoid-report)
+
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/oivoodoo/mongoid-report)
+
### Example
```ruby
class Model
include Mongoid::Document
@@ -43,18 +47,34 @@
group_by :day
aggregation_field :field1
end
end
+
+ class Report5
+ include Mongoid::Report
+
+ attach_to Model, as: 'summary-report' do
+ group_by :day
+
+ aggregation_field :field1
+ end
+ end
```
```ruby
example = Report4.new
- result = example.aggregate_for(Model)
+ scope = example.aggregate_for(Model)
+ scope = scope.query('match' => { 'field1' => 1 })
+ result = scope.all
result.is_a?(Array) => true
result[0].is_a?(Hash) => true
+
+ example = Report5.new
+ scope = example.aggregate_for('summary-report')
+ result = scope.all
```
## Installation
Add this line to your application's Gemfile:
@@ -65,18 +85,14 @@
$ bundle
Or install it yourself as:
- $ gem install mongoid_report
+ $ gem install mongoid-report
-## Usage
-
-TODO: Write usage instructions here
-
## Contributing
-1. Fork it ( http://github.com/<my-github-username>/mongoid_report/fork )
+1. Fork it ( http://github.com/oivoodoo/mongoid-report/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 new Pull Request