README.md in squid-1.0.0.beta4 vs README.md in squid-1.0.0
- old
+ new
@@ -24,131 +24,38 @@
```ruby
data = {views: {2013 => 182, 2014 => 46, 2015 => 134}}
chart data
```
-
+
+A comprehensive guide to Squid options
+======================================
-Graph options
--------------
+All the settings available for the `chart` method are detailed on the [Squid homepage](http://fullscreen.github.io/squid):
-By providing `options` to the `chart` method, you can customize the format of the graph.
+[](http://fullscreen.github.io/squid)
-Multiple options can be combined. Here is a comprehensive list.
+Please proceed to [http://fullscreen.github.io/squid](http://fullscreen.github.io/squid) for more details and examples.
-##### `:type` sets the type of graph. Can be `:column` (default), `:point`, or `:line`.
-
-
-
-##### `:line_width` changes the line width (default: `3`, only applies to line graphs).
-
-
-
-##### `:color` changes the color of the chart (default: `'2e578c'`).
-
-
-
-##### `:steps` changes the number of gridlines (default: `4`).
-
-
-
-##### `:ticks` shows/hides the ticks between the baseline and each category (default: `true`).
-
-
-
-##### `:baseline` shows/hides the baseline (default: `true`).
-
-
-
-##### `:every` specifies how often to show category labels on the baseline (default: `1`).
-
-
-
-##### `:legend` shows/hides the legend (default: `true`).
-
-
-
-##### `:legend` can also set the right and bottom margins of the legend (default: `{right: 0, bottom: 15}`).
-
-
-
-##### `:format` changes the format of the axis labels. Can be `:integer` (default), `:float`, `:percentage`, `:currency`, or `:seconds`.
-
-
-
-##### `:label` shows/hides the value for each point in the graph (default: `false`).
-
-
-
-##### `:border` shows/hides a border around the graph (default: `false`).
-
-
-
-##### `:height` changes the height of the graph (default: `250`).
-
-
-
-Multiple series
----------------
-
-By providing multiple key/values `data` to the `chart` method, you can plot multiple series on a graph.
-
-For instance, the following code generates the graph below:
-
-```ruby
-data = {safari: {2013 => 43.2, 2014 => 46.1, 2015 => 50.7},
- firefox: {2013 => 56.8, 2014 => 53.9, 2015 => 49.3}}
-chart data, labels: true, format: :percentage
-```
-
-
-
-When plotting multiple series, the option `type: :stack` can be set to display stacked columns:
-
-
-
-Any value set for the `:color`, `:format`, `:line_width` and `:label` options will be applied to the first series only:
-
-
-
-To customize each series, use the _plural_ options `:colors`, `:formats`, `:line_widths` and `:labels` instead:
-
-
-
-
-Finally, the option `type: :two_axis` can be set to display two separate axes in your series belong to two different domains.
-
-For instance, the following code generates the graph below:
-
-```ruby
-data = {views: {2013 => 182, 2014 => 46, 2015 => 88},
- earnings: {2013 => 104_323, 2014 => 27_234, 2015 => 14_123}}
-chart data, type: :two_axis
-```
-
-
-
How to install
==============
Squid requires **Ruby 2.1 or higher**.
If used in a Rails project, requires **Rails 4.0 or higher**.
-To include in your project, add `gem 'squid', github: 'fullscreen/squid'` to the `Gemfile` file of your Ruby project.
+To include in your project, add `gem 'squid, ~> 1.0', github: 'fullscreen/squid'` to the `Gemfile` file of your Ruby project.
How to generate the manual
==========================
`rake manual`
How to contribute
=================
If you’ve made it this far in the README… thanks! :v:
-
-I’m about to release version 1 of this gem.
-Feel free to try it out and send issues or pull requests.
+Feel free to try it the gem, explore the code, and send issues or pull requests.
All pull requests will have to make Travis and Code Climate happy in order to be accepted. :kissing_smiling_eyes:
You can also run the tests locally with `bundle exec rspec`.
\ No newline at end of file