Merge pull request #516 from danvk/jstd-coverage
[dygraphs.git] / README.md
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)
2 # dygraphs JavaScript charting library
3
4 The dygraphs JavaScript library produces interactive, zoomable charts of time series:
5
6 <img src="https://cloud.githubusercontent.com/assets/98301/5311286/eb760eea-7c10-11e4-9a59-1d144e51a15b.png" width="618" height="322">
7
8 Learn more about it at [dygraphs.com](http://www.dygraphs.com).
9
10 Get 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
17 * Interactive [pan and zoom](http://dygraphs.com/tests/link-interaction.html)
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
45 Learn more by reading [the tutorial](http://www.dygraphs.com/tutorial.html) and
46 seeing demonstrations of what dygraphs can do in the
47 [gallery](http://www.dygraphs.com/gallery).
48
49 ## Making Changes
50 If you've made a change to dygraphs and would like to contribute it back to the
51 community, please follow the [Guide to making dygraphs
52 changes](http://dygraphs.com/changes.html).
53
54 ## License(s)
55 dygraphs uses:
56  - UglifyJS (BSD License)
57  - JsDoc Toolkit (MIT license)
58  - console-polyfill (MIT license)
59
60 automated tests use:
61  - auto_tests/lib/jquery-1.4.2.js (MIT & GPL2)
62  - auto_tests/lib/Asserts.js (Apache 2.0 License)
63  - auto-tests/lib/JsTestDriver-1.3.3cjar (Apache 2.0 License)
64
65 dygraphs is available under the MIT license, included in LICENSE.txt.