Permalink
Browse files

Rework the README a bit

  • Loading branch information...
1 parent a5f3d82 commit 87ba46ff9fb4ff7a160859bd0498844c179ce21a @danvk committed Dec 29, 2016
Showing with 42 additions and 12 deletions.
  1. +42 −12 README.md
View
@@ -7,18 +7,16 @@ The dygraphs JavaScript library produces interactive, zoomable charts of time se
Learn more about it at [dygraphs.com](http://www.dygraphs.com).
-Get help with dygraphs on
-[Stack Overflow](http://stackoverflow.com/questions/tagged/dygraphs) (preferred) and
-[Google Groups](http://groups.google.com/group/dygraphs-users)
+Get help with dygraphs by browsing the on [Stack Overflow][] (preferred) and [Google Groups][].
## Features
* Plots time series without using an external server or Flash
-* Supports [error bands](http://dygraphs.com/tests/legend-values.html) around data series
-* Interactive [pan and zoom](http://dygraphs.com/tests/link-interaction.html)
-* Displays values [on mouseover](http://dygraphs.com/tests/legend-values.html)
-* Adjustable [averaging period](http://dygraphs.com/tests/temperature-sf-ny.html)
-* Extensive set of [options](http://www.dygraphs.com/options.html) for customization.
-* Compatible with the [Google Visualization API](http://dygraphs.com/data.html#datatable)
+* Supports [error bands][] around data series
+* Interactive [pan and zoom][]
+* Displays values [on mouseover][]
+* Adjustable [averaging period][]
+* Extensive set of [options][] for customization.
+* Compatible with the [Google Visualization API][gviz]
## Minimal Example
```html
@@ -43,9 +41,27 @@ Get help with dygraphs on
</html>
```
-Learn more by reading [the tutorial](http://www.dygraphs.com/tutorial.html) and
-seeing demonstrations of what dygraphs can do in the
-[gallery](http://www.dygraphs.com/gallery).
+Learn more by reading [the tutorial][] and seeing demonstrations of what
+dygraphs can do in the [gallery][]. You can get `dygraph.js` and `dygraph.css`
+from [cdnjs][] or [from NPM][npm] (see below).
+
+## Usage with a module loader
+
+Get dygraphs from NPM:
+
+ npm install dygraphs
+
+You'll find pre-built JS & CSS files in `node_modules/dygraphs/dist`. If you're
+using a module bundler like browserify or webpack, you can import dygraphs:
+
+```js
+import Dygraph from 'dygraphs';
+// or: const Dygraph = require('dygraphs');
+
+const g = new Dygraph('graphdiv', data, { /* options */ });
+```
+
+Check out the [dygraphs-es6 repo][] for a fully-worked example.
## Development
@@ -60,3 +76,17 @@ Read more about the dygraphs development process in the [developer guide](/DEVEL
## License(s)
dygraphs is available under the MIT license, included in LICENSE.txt.
+
+[cdnjs]: https://cdnjs.com/libraries/dygraph
+[the tutorial]: http://www.dygraphs.com/tutorial.html
+[gallery]: http://www.dygraphs.com/gallery
+[error bands]: http://dygraphs.com/tests/legend-values.html
+[pan and zoom]: http://dygraphs.com/tests/link-interaction.html
+[on mouseover]: http://dygraphs.com/tests/legend-values.html
+[averaging period]: http://dygraphs.com/tests/temperature-sf-ny.html
+[options]: http://www.dygraphs.com/options.html
+[Stack Overflow]: http://stackoverflow.com/questions/tagged/dygraphs?sort=votes&pageSize=50
+[Google Groups]: http://groups.google.com/group/dygraphs-users
+[gviz]: http://dygraphs.com/data.html#datatable
+[npm]: https://www.npmjs.com/package/dygraphs
+[dygraphs-es6 repo]: https://github.com/danvk/dygraphs-es6

0 comments on commit 87ba46f

Please sign in to comment.