Update README and Gemfile.lock

jdpace · Apr 8, 2011 · ce4f22e · ce4f22e
1 parent 6b7971b
commit ce4f22e
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -8,4 +8,4 @@ a.out
 *.csv*
 !spec/fixtures/*.csv*
 Makefile
-pkg
+*.gem
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bamfcsv (0.1.0)
+    bamfcsv (0.1.1)
 
 GEM
   remote: http://rubygems.org/

diff --git a/README b/README
@@ -2,11 +2,26 @@ BAMFCSV -- Parsin' CSVs like a BAMF!
 
 $ gem install bamfcsv
 $ irb -rbamfcsv
-irb> BAMFCSV.read "super_giant_properly_formatted.csv"
+irb> BAMFCSV.read "super_giant.csv"
+===> ...large array of arrays...
 
 BAMF!!! CSV IS PARSED IN LESS THAN ONE SECOND! GUARANTEED!*
 
+also:
+BAMFCSV.parse "csv,string,of,awesome"
 
+AND! both #parse and #read take an optional :headers => true to generate a table!
 
+irb(1.9.2): table = BAMFCSV.parse <<EOF, headers: true
+         ?> foo,bar
+         ?> 1,2
+         ?> 3,4
+         ?> EOF
+==========> #<BAMFCSV::Table>
+irb(1.9.2): table.first["foo"]
+==========> "1"
+irb(1.9.2): table[1]["bar"]
+==========> "4"
 
-* Results may vary.
+
+(*) Results may vary.