README.md in pivot_table-0.1.4 vs README.md in pivot_table-0.2.0
- old
+ new
@@ -1,8 +1,7 @@
-# Pivot Table [](http://travis-ci.org/edjames/pivot_table) [](https://codeclimate.com/github/edjames/pivot_table)
+# Pivot Table [](http://travis-ci.org/edjames/pivot_table) [](https://codeclimate.com/github/edjames/pivot_table) [](https://gemnasium.com/edjames/pivot_table)
-
A handy tool for transforming a dataset into a spreadsheet-style pivot table.
### Why make this?
One of the most powerful and underrated features of spreadhseet packages is their ability to create pivot tables. I'm often asked
@@ -101,19 +100,39 @@
g.row_totals
g.rows[0].total
g.rows[1].total
g.grand_total
+#### Configuration Options
+You can also provide additional configuration options when instantiating your Grid. Options are provided as a hash e.g.
+
+ grid = PivotTable::Grid.new(:sort => true) do |g|
+ g.source_data = data
+ g.column_name = :quarter
+ g.row_name = :city
+ g.value_name = :sales
+ end
+
+Here are the available configuration options:
+
+###### 1. Sort
+
+**Usage:** `:sort => false`
+
+**Default:** `true`
+
+This option will automatically sort your data alphabetically based on your column and row headers. If you disable sorting your original data ordering will be preserved.
+
+
### Ruby Support
-----------------
* 1.9.3
* 2.0.0
+* 2.1.0
-Contributing to PivotTable
----------------------
+### Contributing to PivotTable
If you want to contribute:
* Check out the latest master to make sure the feature hasn’t been implemented or the bug hasn’t been fixed yet
* Check out the issue tracker to make sure someone already hasn’t requested it and/or contributed it
@@ -121,9 +140,8 @@
* Start a feature/bugfix branch
* Commit and push until you are happy with your contribution
* Make sure to add tests for it. This is important so I don’t break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history.
-Copyright
----------
+### Copyright
-Copyright (c) 2013 Ed James. See LICENSE for details.
+Copyright (c) 2014 Ed James. See LICENSE for details.