one-pivot 0.9.2 → 0.9.3

data/README.md

@@ -3,7 +3,7 @@
 ##Overview
 The **one-pivot** GEM provides a simple way to mine data from a list of objects. There are no constraints on the types of objects that you can pivot. You can pivot anything from a list of numbers to a list of ActiveRecord objects to anything in between.  
 
-**`One::Pivot`** exposes two methods of importance.  
+**`One::Pivoter`** exposes two methods of importance.  
 
 * **`pivot`** - runs a single pivot 
 * **`multi-pivot`** - stacks multiple pivots into a single result
@@ -14,13 +14,20 @@ Lets have a look at some examples.
 
 _Note: there are a few advanced features not demonstrated in the examples below. For example, adding identifiers to pivots or attaching observers to pivot operations. We use these features at 1on1 to cache pivot results for each item. This gives us a big performance boost when the same item participates in multiple pivots during its lifetime... especially when the pivot Proc is an expensive operation.  Have a look at the [tests](https://github.com/one-on-one/pivot/tree/master/test) when you want to dig a little deeper._
 
+##Installation
+<pre>
+<code>
+gem install one-pivot
+</code>
+</pre>
+
 ##A simple single pivot
 <pre>
 <code>
 require 'one-pivot'
 
 # create the pivot instance
-pivoter = One::Pivot.new
+pivoter = One::Pivoter.new
 
 # create a list of objects to pivot
 list = [1,2,3,4,5,6,7,8,9]
@@ -28,7 +35,7 @@ list = [1,2,3,4,5,6,7,8,9]
 # run a single pivot
 # note: the block passed to the pivot method is invoked for each item in the list
 # note: the result from the block will act as the 'key' in the resulting Hash
-result = pivoter.pivot {|item| item <= 5}
+result = pivoter.pivot(list) {|item| item <= 5}
 
 # 'result' will be a Hash with the following structure
 {
@@ -46,7 +53,7 @@ require 'one-pivot'
 
 # create the pivot instance
 # note: the multi-pivot delimiter that was specified
-pivoter = One::Pivot.new
+pivoter = One::Pivoter.new
 
 # create a list of objects to pivot
 list = [1,2,3,4,5,6,7,8,9]
@@ -117,7 +124,7 @@ result = pivoter.multi_pivot(list, *pivots)
 
 require 'one-pivot'
 
-pivoter = One::Pivot.new
+pivoter = One::Pivoter.new
 # note that the pivot block returns an array
 # each unique value in the arrays returned will become a key in the resulting Hash
 result = pivoter.pivot(User.all) do |user|

metadata

@@ -2,7 +2,7 @@
 name: one-pivot
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors: 
 - Nathan Hopkins