rickshaw_rails 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,14 @@
-# RickshawRails
+# Rickshaw
 
-TODO: Write a gem description
+Rickshaw is a JavaScript toolkit for creating interactive time series graphs, developed at Shutterstock, and uses the d3 data visualization javascript framework
+
+# About D3 
+
+**D3** is a small, free JavaScript library for manipulating HTML documents
+based on data. D3 can help you quickly visualize your data as HTML or SVG,
+handle interactivity, and incorporate smooth transitions and staged animations
+into your pages. You can use D3 as a visualization framework (like Protovis),
+or you can use it to build dynamic pages (like jQuery).
 
 ## Installation
 
@@ -15,10 +23,31 @@ And then execute:
 Or install it yourself as:
 
     $ gem install rickshaw_rails
+# Usage 
+
+All you have to do is include the desired files in your application.js (or another manifest file), like so:
+
+    //= require rickshaw
+
+And similarly with your css manifest (application.css):
+
+    /*
+     *= require rickshaw
+    */
+
+# Additional Files 
+
+I have, for your convenience, thrown d3 (version 2.9.1, I think), into the vendor file, so if you're not using [d3_rails](https://github.com/logical42/d3_rails), then you can either require d3 directly (but before rickshaw) in your manifest:
+
+    //= require d3.v2
+    //= require rickshaw
+
+Or you can just use the manifest file which I threw in here:
+
+    //= require rickshaw_with_d3
 
-## Usage
+and that should include both d3 and rickshaw into you javascripts in the correct order. 
 
-TODO: Write usage instructions here
 
 ## Contributing
 

data/lib/rickshaw_rails/version.rb

@@ -1,3 +1,3 @@
 module RickshawRails
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/rickshaw_rails.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.email       = ["han@logicallsat.com"]
   s.description   = %q{ Rickshaw, a javascript graphing library based on d3, for the rails asset pipeline }
   s.summary       = %q{ Gem installation of javascript framework for data visualization, D3 }
-  s.homepage      = "https://github.com/logical42/rickshaw_rails"
+  s.homepage      = "https://github.com/logical42/rickshaw_railsgi"
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
@@ -16,6 +16,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency "bundler", "~> 1.0.0"
   s.add_development_dependency "rails",   "~> 3.1"
   s.name          = "rickshaw_rails"
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 end
 

data/vendor/assets/javascripts/rickshaw_rails.js

@@ -0,0 +1 @@
+//= require_self

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rickshaw_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -16,7 +16,7 @@ date: 2012-05-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
-  requirement: &70170540038020 !ruby/object:Gem::Requirement
+  requirement: &70301121634040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70170540038020
+  version_requirements: *70301121634040
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70170540037520 !ruby/object:Gem::Requirement
+  requirement: &70301121633540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -35,10 +35,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70170540037520
+  version_requirements: *70301121633540
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70170540037060 !ruby/object:Gem::Requirement
+  requirement: &70301121633080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -46,7 +46,7 @@ dependencies:
         version: '3.1'
   type: :development
   prerelease: false
-  version_requirements: *70170540037060
+  version_requirements: *70301121633080
 description: ! ' Rickshaw, a javascript graphing library based on d3, for the rails
   asset pipeline '
 email:
@@ -66,9 +66,10 @@ files:
 - rickshaw_rails.gemspec
 - vendor/assets/javascripts/d3.v2.js
 - vendor/assets/javascripts/rickshaw.js
+- vendor/assets/javascripts/rickshaw_rails.js
 - vendor/assets/javascripts/rickshaw_with_d3.js
 - vendor/assets/stylesheets/rickshaw.css
-homepage: https://github.com/logical42/rickshaw_rails
+homepage: https://github.com/logical42/rickshaw_railsgi
 licenses: []
 post_install_message: 
 rdoc_options: []