Merge pull request #464 from danvk/sourcemap
[dygraphs.git] / README
1 dygraphs JavaScript charting library
2 Version 1.0.1
3 Copyright (c) 2006-, Dan Vanderkam.
4
5 Documentation: http://dygraphs.com/
6 Support: http://stackoverflow.com/questions/tagged/dygraphs
7          http://groups.google.com/group/dygraphs-users
8 Source: http://github.com/danvk/dygraphs
9 Issues: https://github.com/danvk/dygraphs/issues
10
11
12 The dygraphs JavaScript library produces interactive, zoomable charts of time series.
13
14 Features
15 - Plots time series without using an external server or Flash
16 - Supports multiple data series
17 - Supports error bands around data series
18 - Displays values on mouseover
19 - Interactive zoom
20 - Adjustable averaging period
21 - Customizable click-through actions
22 - Compatible with the Google Visualization API
23
24 Demo
25 For a gallery and documentation, see http://dygraphs.com/
26
27 Minimal Example
28 <html>
29 <head>
30 <script type="text/javascript" src="dygraph-combined.js"></script>
31 </head>
32 <body>
33 <div id="graphdiv"></div>
34 <script type="text/javascript">
35   g = new Dygraph(
36         document.getElementById("graphdiv"),  // containing div
37         "Date,Temperature\n" +                // the data series
38         "2008-05-07,75\n" +
39         "2008-05-08,70\n" +
40         "2008-05-09,80\n",
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  - excanvas.js (Apache License)
54  - YUI compressor (BSD License)
55  - JsDoc Toolkit (MIT license)
56  - console-polyfill (MIT 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.3cjar (Apache 2.0 License
62
63 Linter uses:
64  - JSHint (modified MIT license; prevents evil)
65
66 excanvas: http://code.google.com/p/explorercanvas/
67 yui compressor: http://developer.yahoo.com/yui/compressor/
68 jsdoc toolkit: http://code.google.com/p/jsdoc-toolkit/
69
70 jquery: http://code.jquery.com/jquery-1.4.2.js
71 Asserts.js: http://www.google.com/codesearch/p?#3tsINRJRCro/trunk/JsTestDriver/src/com/google/jstestdriver/javascript/Asserts.js
72 JSTestDriver: http://code.google.com/p/js-test-driver/
73
74 JSHint: jshint.com
75
76 dygraphs is available under the MIT license, included in LICENSE.txt.