README.md in metrics-graphics-rails-2.6.0 vs README.md in metrics-graphics-rails-2.6.0.1
- old
+ new
@@ -1,11 +1,11 @@
metrics-graphics-rails
============
[metrics-graphics](https://github.com/mozilla/metrics-graphics) is a library optimized for concise, principled data graphics and layouts. See more in [metricsgraphicsjs.org](http://metricsgraphicsjs.org)
-The **metrics-graphics-rails** provides metrics-graphics for Rails and the assets pipeline.
+The **metrics-graphics-rails** provides metrics-graphics v2.6.0 for Rails and the assets pipeline.
## Usage
Add this gem to your Gemfile:
@@ -43,18 +43,32 @@
y_accessor: 'value'
})
This graph can be rendered in a Rails view template with this helper:
- = metrics_graphic_for data, title: "Downloads", description: "This graphic shows a time-series of downloads.", width: 600, height: 250, target: '#downloads', x_accessor: 'date', y_accessor: 'value', time_format: '%Y-%m-%d'
+ = metrics_graphic_for data, target: '#downloads', title: "Downloads", description: "This graphic shows a time-series of downloads.", width: 600, height: 250, x_accessor: 'date', y_accessor: 'value', time_format: '%Y-%m-%d'
where ``data`` is an Array of Hashes of points with a ``date`` and a ``value`` keys and values. Ex: ``[{date: '2014-11-01', value: 12}, {date: '2014-11-02', value: 18}]``
`width`, `height`, `time_format` and `description` are optional options.
### Multiple lines
`metrics_graphic_for` helper supports multiple-lined graphs generation. Just pass data as an Array of Arrays in the same format as for single-lined graphs and it should work as a charm.
+
+### Markers
+
+`metrics_graphic_for` helper supports markers. Just pass marker data as an Array with the `markers` option like this:
+
+ = metrics_graphic_for data, target: '#downloads', markers: markers
+
+where ``markers`` is an Array of Hashes of markers with ``date`` and a ``label`` keys and values. Ex: ``[{date: '2014-11-01', label: 'look here!'}, {date: '2014-11-02', label: 'look there!'}]``
+
+### Other options
+
+Do you want to use any *metrics-graphics* option not included in `metrics_graphic_for` view helper? Just pass them as a Hash in the `:extra_options` attribute like this:
+
+ = metrics_graphic_for data, target: '#downloads', extra_options: { min_y: 100, max_y: 200 }
## Versioning
metrics-graphics-rails 2.6.0 == metrics-graphics 2.6.0