README.rdoc in csv-mapper-0.0.3 vs README.rdoc in csv-mapper-0.0.4
- old
+ new
@@ -1,12 +1,10 @@
= README
-by Luke Pillow
-
== DESCRIPTION:
-CsvMapper is a small library intended to simplify the common steps involved with importing CSV files to a usable form in Ruby.
+CsvMapper is a small library intended to simplify the common steps involved with importing CSV files to a usable form in Ruby. CsvMapper is compatible with recent 1.8 versions of Ruby as well as Ruby 1.9+
== EXAMPLES:
The following example will import a CSV file to an Array of OpenStruct[http://ruby-doc.org/core/classes/OpenStruct.html] instances.
@@ -28,10 +26,21 @@
results.first.first_name # John
results.first.last_name # Doe
results.first.age # 27
+==== Automagical Attribute Discovery Example
+ include CsvMapper
+
+ results = import('/path/to/file.csv') do
+ read_attributes_from_file
+ end
+
+ results.first.first_name # John
+ results.first.last_name # Doe
+ results.first.age # 27
+
==== Import to ActiveRecord Example
Although CsvMapper has no dependency on ActiveRecord; it's easy to import a CSV file to ActiveRecord models and save them.
# Define an ActiveRecord model
class Person < ActiveRecord::Base; end
@@ -48,10 +57,10 @@
See CsvMapper for a more detailed description
== REQUIREMENTS:
-FasterCSV[http://fastercsv.rubyforge.org/]
+FasterCSV[http://fastercsv.rubyforge.org/] on pre 1.9 versions of Ruby
== INSTALL:
* sudo gem install csv-mapper
\ No newline at end of file