Merge pull request #634 from mjanda/master
[dygraphs.git] / README.md
CommitLineData
9f3f36f8 1[![Build Status](https://travis-ci.org/danvk/dygraphs.svg?branch=markdown-readme)](https://travis-ci.org/danvk/dygraphs) [![Coverage Status](https://img.shields.io/coveralls/danvk/dygraphs.svg)](https://coveralls.io/r/danvk/dygraphs)
215e9e97
DV
2# dygraphs JavaScript charting library
3
4The dygraphs JavaScript library produces interactive, zoomable charts of time series:
5
067641c1 6<img src="https://cloud.githubusercontent.com/assets/98301/5311286/eb760eea-7c10-11e4-9a59-1d144e51a15b.png" width="618" height="322">
215e9e97
DV
7
8Learn more about it at [dygraphs.com](http://www.dygraphs.com).
9
10Get help with dygraphs on
11[Stack Overflow](http://stackoverflow.com/questions/tagged/dygraphs) (preferred) and
12[Google Groups](http://groups.google.com/group/dygraphs-users)
13
14## Features
15* Plots time series without using an external server or Flash
16* Supports [error bands](http://dygraphs.com/tests/legend-values.html) around data series
067641c1 17* Interactive [pan and zoom](http://dygraphs.com/tests/link-interaction.html)
215e9e97
DV
18* Displays values [on mouseover](http://dygraphs.com/tests/legend-values.html)
19* Adjustable [averaging period](http://dygraphs.com/tests/temperature-sf-ny.html)
20* Extensive set of [options](http://www.dygraphs.com/options.html) for customization.
21* Compatible with the [Google Visualization API](http://dygraphs.com/data.html#datatable)
22
23## Minimal Example
24```html
25<html>
26<head>
27<script type="text/javascript" src="dygraph-combined.js"></script>
28</head>
29<body>
30<div id="graphdiv"></div>
31<script type="text/javascript">
32 g = new Dygraph(
33 document.getElementById("graphdiv"), // containing div
34 "Date,Temperature\n" + // the data series
35 "2008-05-07,75\n" +
36 "2008-05-08,70\n" +
37 "2008-05-09,80\n",
38 { } // the options
39 );
40</script>
41</body>
42</html>
43```
44
45Learn more by reading [the tutorial](http://www.dygraphs.com/tutorial.html) and
46seeing demonstrations of what dygraphs can do in the
47[gallery](http://www.dygraphs.com/gallery).
48
341a2d65
DV
49## Development
50
51To get going, clone the repo and run:
52
53 npm install
54 gulp dist
55
56Read more about the dygraphs development process in the [developer guide](/DEVELOP.md).
215e9e97
DV
57
58## License(s)
59dygraphs uses:
60 - UglifyJS (BSD License)
61 - JsDoc Toolkit (MIT license)
62 - console-polyfill (MIT license)
63
64automated tests use:
65 - auto_tests/lib/jquery-1.4.2.js (MIT & GPL2)
66 - auto_tests/lib/Asserts.js (Apache 2.0 License)
67 - auto-tests/lib/JsTestDriver-1.3.3cjar (Apache 2.0 License)
68
69dygraphs is available under the MIT license, included in LICENSE.txt.