Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
iblue committed Dec 16, 2015
1 parent be2c379 commit e132a0a
Showing 1 changed file with 22 additions and 9 deletions.
31 changes: 22 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
# d3-rails

[D3.js](http://github.com/mbostock/d3) is a JavaScript library for manipulating documents based on data. D3 helps you bring data to life using HTML, SVG and CSS.
[D3.js](http://github.com/mbostock/d3) is a JavaScript library for
manipulating documents based on data. D3 helps you bring data to life
using HTML, SVG and CSS.

d3-rails provides D3 for Rails 3.1 and higher.

## Version

d3-rails comes with version 3.5.11 of D3.js. and will track the always
mirror the version of D3 it comes with.
d3-rails comes with version 3.5.11 of D3.js. The d3-rails version will
always mirror the version of D3. If you need a newer version of
d3-rails, see section Development (below).


## Installation
Expand All @@ -16,15 +19,25 @@ Add this line to your `Gemfile`:

gem "d3-rails"

Please note that D3 is provided via the asset pipeline and you do *not* need to copy their files into your application. Rails will get them from d3-rails automatically.
Please note that D3 is provided via the asset pipeline and you do *not*
need to copy their files into your application. Rails will get them from
d3-rails automatically.

Then add it to your manifest file, most probably at `app/assets/javascripts/application.js`:
Then add it to your manifest file, most probably at
`app/assets/javascripts/application.js`:

//= require d3

## Development

To update the D3 version contained in the gem, you can run the following rake task
```bash
bundle exec rake d3:update_version
```
If you need a newer version of d3, please do the following:

1. Fork this repository
2. Clone your repository to a local directory
3. Create a branch called update-version in your repository
4. Run `bundle exec rake d3:update_version`
5. Create a commit stating the version you updated to
6. Push to your repository
7. Create a pull request

I will then merge and release a new version of the gem.

0 comments on commit e132a0a

Please sign in to comment.