Update global README with updated example, and license information for auto-tests.
[dygraphs.git] / README
1 dygraphs JavaScript charting library
2 Copyright (c) 2006-, Dan Vanderkam.
3
4 Documentation: http://dygraphs.com/
5 Support: http://groups.google.com/group/dygraphs-users
6 Source: http://github.com/danvk/dygraphs
7 Issues: http://code.google.com/p/dygraphs/
8
9
10 The dygraphs JavaScript library produces produces interactive, zoomable charts of time series.
11
12 Features
13 - Plots time series without using an external server or Flash
14 - Supports multiple data series
15 - Supports error bands around data series
16 - Displays values on mouseover
17 - Interactive zoom
18 - Adjustable averaging period
19 - Customizable click-through actions
20 - Compatible with the Google Visualization API
21
22 Demo
23 For a gallery and documentation, see http://dygraphs.com/
24
25 Minimal Example
26 <html>
27 <head>
28 <script type="text/javascript" src="dygraph-combined.js"></script>
29 </head>
30 <body>
31 <div id="graphdiv"></div>
32 <script type="text/javascript">
33   g = new Dygraph(
34         document.getElementById("graphdiv"),  // containing div
35         [
36           [ 'Date', 'Temperature' ],          // the data series
37           [ '2008-05-07', 75 ],
38           [ '2008-05-08', 70 ],
39           [ '2008-05-09', 80 ]
40         ],
41         { }                                   // the options
42       );
43 </script>
44 </body>
45 </html>
46
47 Making Changes
48 If you've made a change to dygraphs and would like to contribute it back to the
49 community, please follow the guide at http://dygraphs.com/changes.html.
50
51 License(s)
52 dygraphs uses:
53  - rgbcolor.js (Public Domain)
54  - strftime.js (BSD License)
55  - excanvas.js (Apache License)
56  - YUI compressor (BSD License)
57
58 automated tests use:
59  - auto_tests/lib/jquery-1.4.2.js (MIT & GPL2)
60  - auto_tests/lib/Asserts.js (Apache 2.0 License)
61  - auto-tests/lib/JsTestDriver-1.3.2.jar (Apache 2.0 License
62
63 rgbcolor: http://www.phpied.com/rgb-color-parser-in-javascript/
64 strftime: http://tech.bluesmoon.info/2008/04/strftime-in-javascript.html
65 excanvas: http://code.google.com/p/explorercanvas/
66 yui compressor: http://developer.yahoo.com/yui/compressor/
67
68 jquery: http://code.jquery.com/jquery-1.4.2.js
69 Asserts.js: http://www.google.com/codesearch/p?#3tsINRJRCro/trunk/JsTestDriver/src/com/google/jstestdriver/javascript/Asserts.js
70 JSTestDriver: http://code.google.com/p/js-test-driver/
71
72 dygraphs is available under the MIT license, included in LICENSE.txt.