Add screenshot
[dygraphs.git] / README.md
1 # dygraphs JavaScript charting library
2
3 The dygraphs JavaScript library produces interactive, zoomable charts of time series:
4
5 <img src="https://cloud.githubusercontent.com/assets/98301/5311286/eb760eea-7c10-11e4-9a59-1d144e51a15b.png" width="618" height="322">
6
7 Learn more about it at [dygraphs.com](http://www.dygraphs.com).
8
9 Get help with dygraphs on
10 [Stack Overflow](http://stackoverflow.com/questions/tagged/dygraphs) (preferred) and 
11 [Google Groups](http://groups.google.com/group/dygraphs-users)
12
13 ## Features
14 * Plots time series without using an external server or Flash
15 * Supports [error bands](http://dygraphs.com/tests/legend-values.html) around data series
16 * Interactive [pan and zoom](http://dygraphs.com/tests/link-interaction.html)
17 * Displays values [on mouseover](http://dygraphs.com/tests/legend-values.html)
18 * Adjustable [averaging period](http://dygraphs.com/tests/temperature-sf-ny.html)
19 * Extensive set of [options](http://www.dygraphs.com/options.html) for customization.
20 * Compatible with the [Google Visualization API](http://dygraphs.com/data.html#datatable)
21
22 ## Minimal Example
23 ```html
24 <html>
25 <head>
26 <script type="text/javascript" src="dygraph-combined.js"></script>
27 </head>
28 <body>
29 <div id="graphdiv"></div>
30 <script type="text/javascript">
31   g = new Dygraph(
32         document.getElementById("graphdiv"),  // containing div
33         "Date,Temperature\n" +                // the data series
34         "2008-05-07,75\n" +
35         "2008-05-08,70\n" +
36         "2008-05-09,80\n",
37         { }                                   // the options
38       );
39 </script>
40 </body>
41 </html>
42 ```
43
44 Learn more by reading [the tutorial](http://www.dygraphs.com/tutorial.html) and
45 seeing demonstrations of what dygraphs can do in the
46 [gallery](http://www.dygraphs.com/gallery).
47
48 ## Making Changes
49 If you've made a change to dygraphs and would like to contribute it back to the
50 community, please follow the [Guide to making dygraphs
51 changes](http://dygraphs.com/changes.html).
52
53 ## License(s)
54 dygraphs uses:
55  - UglifyJS (BSD License)
56  - JsDoc Toolkit (MIT license)
57  - console-polyfill (MIT license)
58
59 automated tests use:
60  - auto_tests/lib/jquery-1.4.2.js (MIT & GPL2)
61  - auto_tests/lib/Asserts.js (Apache 2.0 License)
62  - auto-tests/lib/JsTestDriver-1.3.3cjar (Apache 2.0 License)
63
64 dygraphs is available under the MIT license, included in LICENSE.txt.