From e132a0aa4de4cb396fa378244cea55f2a4919587 Mon Sep 17 00:00:00 2001 From: Markus Fenske Date: Wed, 16 Dec 2015 17:10:28 +0100 Subject: [PATCH] Update README.md --- README.md | 31 ++++++++++++++++++++++--------- 1 file changed, 22 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 36406af..4976b82 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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.