diff --git a/README.md b/README.md index 7370229..f2f6c85 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,5 @@ -Please see Novus' official statement on nvd3 with an explanation, -apology, and commitment to its permanent status as an open-source -project. -[http://nvd3.org/statement.html](http://nvd3.org/statement.html) - -# nvd3 - v1.1.x-beta -## Release notes for version 1.1 beta +# NVD3 - v1.1.10-beta +## Release notes for version 1.1.10 beta * Line charts now have a new tooltip option available. This new tooltip displays all series information at once, and shows up anywhere your mouse moves. To enable, set **useInteractiveGuideline** to true. See examples in the **test/** directory for how this tooltip works. * New test pages have been created for various kinds of charts. They live in the **test/** directory. The goal of these test pages is to aid @@ -20,6 +15,7 @@ to the containing chart DIV. * Issue #216: Exposing xRange and yRange overrides for all charts. * Issue #168: Adding legend.radioButtonMode(). When set to true, legend click behavior will match those of radio buttons. * Line stroke-width has been reduced to 1.5px, from 2.5px. +* Hover points on line and stacked area charts are now a small solid dot, instead of a large ring. * Added Multibar chart property "groupSpacing". * Charts now have a method called "options()", where you can pass in chart configurations via an object. * examples/index.html page created, for quick access to all NVD3 examples and test pages. @@ -29,15 +25,16 @@ A reusable chart library for d3.js. NVD3 may change from its current state, but will always try to follow the style of d3.js. -You can also check out the [examples page](http://nvd3.org/ghpages/examples.html) +You can also check out the [examples page](http://nvd3.org/ghpages/examples.html). +**Note:** The examples on nvd3.org are outdated. For examples on how to use the latest NVD3, please checkout the **examples/** directory in the repository. --- # Current development focus -- Error bars in bar charts -- Unifying common API functions between charts -- Bug fixes all around +- Getting documentation up. +- Unifying common API functions between charts. +- Bug fixes that come up. --- @@ -57,7 +54,7 @@ We cannot honor all pull requests, but we will review all of them. Please do not aggregate pull requests. Aggregated pull requests are actually more difficult to review. -We are currently changing our branch structure so that master will be gauranteed stable. In addition, there is now a "development" branch. This branch reflects the latest changes to nvd3 and is not necessarily stable. +We are currently changing our branch structure so that master will be gauranteed stable. In addition, there is now a "development" branch. This branch reflects the latest changes to NVD3 and is not necessarily stable. --- @@ -85,7 +82,7 @@ Then, you can use these commands: grunt # build nv.d3.js grunt production # build nv.d3.js and nv.d3.min.js - grunt watch # watch file changes in src/, and rebuild nv.d3.js, it's very helpful when delevop nvd3 + grunt watch # watch file changes in src/, and rebuild nv.d3.js, it's very helpful when delevop NVD3 grunt lint # run jshint on src/**/*.js **We ask that you DO NOT minify pull requests... @@ -93,10 +90,10 @@ If you need to minify please build pull request in separate branch, and merge and minify in your master. ## Supported Browsers +NVD3 runs best on WebKit based browsers. -* Chrome latest version (preferred) -* Firefox latest version -* Safari latest version -* Internet Explorer 9 and 10 -* Opera 15+. - +* **Google Chrome: latest version (preferred)** +* **Opera 15+ (preferred)** +* Safari: latest version +* Firefox: latest version +* Internet Explorer: 9 and 10