README.rdoc in csv_pirate-5.0.7 vs README.rdoc in csv_pirate-5.0.8
- old
+ new
@@ -1,12 +1,18 @@
== CsvPirate {<img src="https://codeclimate.com/badge.png" />}[https://codeclimate.com/github/pboling/csv_pirate] {<img src="https://secure.travis-ci.org/pboling/csv_pirate.png?branch=master" alt="Build Status" />}[http://travis-ci.org/pboling/csv_pirate] {<img src="http://api.coderwall.com/pboling/endorsecount.png" />}[http://coderwall.com/pboling]
Easily create CSVs of any data that can be derived from your models.
CsvPirate is the easy way to create a CSV of essentially anything in Ruby, in full pirate regalia.
-It works better if you are wearing a tricorne! Now compatible with Ruby 1.8.7 & 1.9.2, and Rails 2 & 3!
+It works better if you are wearing a tricorne!
+Compatible with:
+
+Ruby 1.8.7 (Must also install/require 'faster_csv')
+Ruby 1.9.2, 1.9.3, and 2.0.0
+Rails 2, 3, and 4
+
Everything in the source that depended on Rails extensions of Ruby classes has been refactored to work in pure Ruby!
My goal is to have it do EVERYTHING it possibly can for me, since almost every project I do needs CSV exports.
CsvPirate only works for commissions of swag OR grub!
@@ -48,10 +54,15 @@
== Install
[sudo] gem install csv_pirate
+ If you are still using Ruby < 1.9 then you will need to add fastercsv to your project.
+ FasterCSV became the built-in CSV library in Ruby 1.9, so is *only* required if using an older Ruby.
+
+ gem 'faster_csv', '>= 1.4.0'
+
== Upgrading
From version prior to 5.0
NinthBit::PirateShip::ActMethods has been deprecated in favor of CsvPirate::PirateShip::ActMethods.
@@ -396,18 +407,17 @@
To run tests cd to where ever you have csv_pirate installed, and do:
rake spec
-== BUGS (Not mine, Micrsoft's)
+== Compatibility with Micrsoft Excel
Microsoft Office (Excel) "SYLK Invalid Format" Error will occur if the string "ID" (without quotes)
is at the beginning of the CSV file. This is strangely inconvenient for rails CSVs since every table
in rails starts with an id column. So buyer beware... make your first column lower case 'id'
if you need to export the id field.
-Micrsoft... I loathe you.
http://www.bradino.com/misc/sylk-file-format-is-not-valid/
== Contributing to CsvPirate
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
@@ -424,16 +434,31 @@
http://github.com/pboling/csv_pirate
Release Announcement:
http://galtzo.blogspot.com/2009/03/csv-pirate.html
+== Versioning
+
+This library aims to adhere to {Semantic Versioning 2.0.0}[http://semver.org/].
+Violations of this scheme should be reported as bugs. Specifically,
+if a minor or patch version is released that breaks backward
+compatibility, a new version should be immediately released that
+restores compatibility. Breaking changes to the public API will
+only be introduced with new major versions.
+
+As a result of this policy, you can (and should) specify a
+dependency on this gem using the {Pessimistic Version Constraint}[http://docs.rubygems.org/read/chapter/16#page74] with two digits of precision.
+
+For example:
+
+ spec.add_dependency 'csv_pirate', '~> 5.0'
+
== Thanks
Thanks go to:
-* 9thBit LLC (http://www.9thBit.net) - Peter Boling, author of CsvPirate, runs the joint.
-* Sagebit LLC (http://www.sagebit.com) - Sagebit has been very supportive of my open source efforts, thanks Ben!
+* [Peter Boling](http://railsbling.com), author of CsvPirate, runs the joint.
* TimePerks LLC (http://www.timeperks.com) - Many useful enhancements were requested and paid for by TimePerks
----------------------------------------------------------------------------------
Author: Peter Boling, peter.boling at gmail dot com
- Copyright (c) 2008-2012 Peter H. Boling of 9thBit LLC, released under the MIT license. See LICENSE for details.
+ Copyright (c) 2008-2013 Peter H. Boling of 9thBit LLC, released under the MIT license. See LICENSE for details.