README.md in render_csv-0.0.1 vs README.md in render_csv-1.0.0
- old
+ new
@@ -1,20 +1,35 @@
# render_csv
-Rails 3 CSV renderer for ActiveRecord collections
+[![Build Status](https://travis-ci.org/beerlington/render_csv.png?branch=master)](https://travis-ci.org/beerlington/render_csv)
+[![Gem Version](https://badge.fury.io/rb/render_csv.png)](http://badge.fury.io/rb/render_csv)
+[![Code Climate](https://codeclimate.com/github/beerlington/render_csv.png)](https://codeclimate.com/github/beerlington/render_csv)
+[![Dependency Status](https://gemnasium.com/beerlington/render_csv.png)](https://gemnasium.com/beerlington/render_csv)
+Rails CSV renderer for ActiveRecord collections
+
+## Rails & Ruby Versions Supported
+
+*Rails:* 3.0.x - 4.0.x
+
+*Ruby:* 1.8.7, 1.9.2, 1.9.3 and 2.0.0
+
+## Installation
+
+The gem is hosted at [rubygems.org](https://rubygems.org/gems/render_csv)
+
## What is it?
The CSV renderer allows you to render any collection as CSV data.
```ruby
class LocationsController < ApplicationController
def index
@locations = Location.all
respond_to do |format|
- format.csv { render :csv => @locations }
+ format.csv { render csv: @locations }
end
end
end
```
@@ -41,48 +56,37 @@
### Exclude columns
```ruby
respond_to do |format|
- format.csv { render :csv => @locations, :except => [:id] }
+ format.csv { render csv: @locations, except: [:id] }
end
```
### Limit columns
```ruby
respond_to do |format|
- format.csv { render :csv => @locations, :only => [:address, :zip] }
+ format.csv { render csv: @locations, only: [:address, :zip] }
end
```
### Add methods as columns
```ruby
respond_to do |format|
- format.csv { render :csv => @locations, :add_methods => [:method1, :method2] }
+ format.csv { render csv: @locations, add_methods: [:method1, :method2] }
end
```
### Add methods as columns and exclude columns
```ruby
respond_to do |format|
- format.csv { render :csv => @locations, :except => [:id], :add_methods => [:method1, :method2] }
+ format.csv { render csv: @locations, except: [:id], add_methods: [:method1, :method2] }
end
```
-## Contributing to render_csv
-
-* 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
-* Fork the project
-* 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. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
## Copyright
-Copyright (c) 2011-2012 Peter Brown. See LICENSE.txt for
+Copyright (c) 2011-2013 Peter Brown. See LICENSE.txt for
further details.
-