streamy_csv 0.1.0 → 0.2.0

data/README.md

@@ -1,6 +1,6 @@
 # StreamyCsv
 
-TODO: Write a gem description
+Streams CSV files one row at a time as live data is generated instead of waiting for the whole file to be created and then sent to the client. Works on most standard web servers including Nginx, Passenger, Unicorn, Thin etc., but does NOT work on Webrick.
 
 ## Installation
 
@@ -17,8 +17,35 @@ Or install it yourself as:
     $ gem install streamy_csv
 
 ## Usage
+In your model:
 
-TODO: Write usage instructions here
+    class MyModel
+
+      def self.header_row
+        CSV::Row([:name, :title], ['Name', 'Title'], true)
+      end
+
+      def to_csv_row
+        CSV::Row(name: name, title: title)
+      end
+
+    end
+
+
+In your controller:
+
+    Class ExportsController
+
+      def index
+
+        stream_csv('data.csv', MyModel.header_row) do |rows|
+          MyModel.find_each do |my_model|
+            rows << my_model.to_csv_row
+          end
+        end
+
+      end
+    end
 
 ## Contributing
 

data/lib/streamy_csv/version.rb

@@ -1,3 +1,3 @@
 module StreamyCsv
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: streamy_csv
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors: