README.md in reports_kit-0.0.4 vs README.md in reports_kit-0.1.0
- old
+ new
@@ -1,29 +1,27 @@
ReportsKit
=====
ReportsKit lets you easily create beautiful charts with customizable, interactive filters.
-Add powerful reporting to your Rails app in minutes, not months!
-
For interactive examples, see [reportskit.co](https://www.reportskit.co/).
---
-[<img src="docs/images/demo.gif?raw=true" width="500" />](docs/images/demo.gif?raw=true)
+[<img src="docs/images/demo.gif?raw=true" width="700" />](docs/images/demo.gif?raw=true)
-[<img src="docs/images/demo_area.png?raw=true" width="500" />](docs/images/demo_area.png?raw=true)
+[<img src="docs/images/demo_area.png?raw=true" width="425" />](docs/images/demo_area.png?raw=true)
+
+[<img src="docs/images/demo_dashed_line.png?raw=true" width="425" />](docs/images/demo_dashed_line.png?raw=true)
-[<img src="docs/images/demo_dashed_line.png?raw=true" width="500" />](docs/images/demo_dashed_line.png?raw=true)
+[<img src="docs/images/demo_horizontal_stacked.png?raw=true" width="425" />](docs/images/demo_horizontal_stacked.png?raw=true)
+
+[<img src="docs/images/demo_legend.png?raw=true" width="425" />](docs/images/demo_legend.png?raw=true)
-[<img src="docs/images/demo_horizontal_stacked.png?raw=true" width="500" />](docs/images/demo_horizontal_stacked.png?raw=true)
+[<img src="docs/images/demo_multiautocomplete.png?raw=true" width="425" />](docs/images/demo_multiautocomplete.png?raw=true)
+
+[<img src="docs/images/demo_radar.png?raw=true" width="230" />](docs/images/demo_radar.png?raw=true)
-[<img src="docs/images/demo_legend.png?raw=true" width="500" />](docs/images/demo_legend.png?raw=true)
-
-[<img src="docs/images/demo_multiautocomplete.png?raw=true" width="500" />](docs/images/demo_multiautocomplete.png?raw=true)
-
-[<img src="docs/images/demo_radar.png?raw=true" width="250" />](docs/images/demo_radar.png?raw=true)
-
---
1. **Quick setup** - Install ReportsKit and create your first chart in less than one minute using just ~5 lines of code.
1. **Simple chart configuration** - Create charts using your existing Rails models. ReportsKit examines the column types and associations to understand how to render the chart.
1. **Powerful results** - To see what ReportsKit can create with minimal code, see [reportskit.co](https://www.reportskit.co/).
@@ -32,11 +30,11 @@
---------
* [Installation](#installation)
* [Quick Start](#quick-start)
* [Examples](https://www.reportskit.co/)
-* [Documentation](documentation)
+* [Documentation](docs)
Installation
------------
In `Gemfile`:
@@ -113,10 +111,19 @@
In the Quick Start chart, `measure: 'user'` tells ReportsKit to count the number of `User` records, and `dimensions: ['created_at']` tells it to group by the week of the `created_at` column. Since `created_at` is a `datetime` column, ReportsKit knows that it should sort the results chronologically.
To learn how to use more of ReportsKit's features, check out the following resources:
* [Examples](https://www.reportskit.co/)
-* [Documentation](documentation)
+* [Documentation](docs)
+
+Testing
+-------
+
+ReportsKit is tested against PostgreSQL and MySQL. If you'd like to submit a PR, please be sure to use [Appraisal](https://github.com/thoughtbot/appraisal) to test your changes in both contexts:
+
+```bash
+appraisal rspec
+```
License
-------
ReportsKit is released under the MIT License. Please see the MIT-LICENSE file for details.