CONTRIBUTING.md formatting
[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://groups.google.com/group/dygraphs-users
7 Source: http://github.com/danvk/dygraphs
8 Issues: http://code.google.com/p/dygraphs/
9
10
11 The dygraphs JavaScript library produces interactive, zoomable charts of time series.
12
13 Features
14 - Plots time series without using an external server or Flash
15 - Supports multiple data series
16 - Supports error bands around data series
17 - Displays values on mouseover
18 - Interactive zoom
19 - Adjustable averaging period
20 - Customizable click-through actions
21 - Compatible with the Google Visualization API
22
23 Demo
24 For a gallery and documentation, see http://dygraphs.com/
25
26 Minimal Example
27 <html>
28 <head>
29 <script type="text/javascript" src="dygraph-combined.js"></script>
30 </head>
31 <body>
32 <div id="graphdiv"></div>
33 <script type="text/javascript">
34   g = new Dygraph(
35         document.getElementById("graphdiv"),  // containing div
36         "Date,Temperature\n" +                // the data series
37         "2008-05-07,75\n" +
38         "2008-05-08,70\n" +
39         "2008-05-09,80\n",
40         { }                                   // the options
41       );
42 </script>
43 </body>
44 </html>
45
46 Making Changes
47 If you've made a change to dygraphs and would like to contribute it back to the
48 community, please follow the guide at http://dygraphs.com/changes.html.
49
50 License(s)
51 dygraphs uses:
52  - excanvas.js (Apache License)
53  - YUI compressor (BSD License)
54  - JsDoc Toolkit (MIT license)
55  - stacktrace.js is public domain
56
57 automated tests use:
58  - auto_tests/lib/jquery-1.4.2.js (MIT & GPL2)
59  - auto_tests/lib/Asserts.js (Apache 2.0 License)
60  - auto-tests/lib/JsTestDriver-1.3.3cjar (Apache 2.0 License
61
62 Linter uses:
63  - JSHint (modified MIT license; prevents evil)
64
65 excanvas: http://code.google.com/p/explorercanvas/
66 yui compressor: http://developer.yahoo.com/yui/compressor/
67 jsdoc toolkit: http://code.google.com/p/jsdoc-toolkit/
68
69 jquery: http://code.jquery.com/jquery-1.4.2.js
70 Asserts.js: http://www.google.com/codesearch/p?#3tsINRJRCro/trunk/JsTestDriver/src/com/google/jstestdriver/javascript/Asserts.js
71 JSTestDriver: http://code.google.com/p/js-test-driver/
72
73 JSHint: jshint.com
74
75 dygraphs is available under the MIT license, included in LICENSE.txt.