CONTRIBUTING.md formatting
[dygraphs.git] / README
CommitLineData
19e4f838 1dygraphs JavaScript charting library
e4b58391 2Version 1.0.1
19e4f838 3Copyright (c) 2006-, Dan Vanderkam.
c5b6da49 4
727439b4 5Documentation: http://dygraphs.com/
c5b6da49
DV
6Support: http://groups.google.com/group/dygraphs-users
7Source: http://github.com/danvk/dygraphs
8Issues: http://code.google.com/p/dygraphs/
8af5b23b 9
19e4f838 10
e79c8bec 11The dygraphs JavaScript library produces interactive, zoomable charts of time series.
19e4f838
DV
12
13Features
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
285a6bda 21- Compatible with the Google Visualization API
19e4f838 22
19e4f838 23Demo
727439b4 24For a gallery and documentation, see http://dygraphs.com/
19e4f838
DV
25
26Minimal Example
27<html>
28<head>
29<script type="text/javascript" src="dygraph-combined.js"></script>
30</head>
31<body>
285a6bda 32<div id="graphdiv"></div>
19e4f838 33<script type="text/javascript">
61b5e925 34 g = new Dygraph(
19e4f838 35 document.getElementById("graphdiv"), // containing div
285a6bda
DV
36 "Date,Temperature\n" + // the data series
37 "2008-05-07,75\n" +
38 "2008-05-08,70\n" +
aea23d5f 39 "2008-05-09,80\n",
916a000e 40 { } // the options
19e4f838
DV
41 );
42</script>
43</body>
44</html>
45
cd12bba0
DV
46Making Changes
47If you've made a change to dygraphs and would like to contribute it back to the
48community, please follow the guide at http://dygraphs.com/changes.html.
49
19e4f838
DV
50License(s)
51dygraphs uses:
19e4f838 52 - excanvas.js (Apache License)
f18986e5 53 - YUI compressor (BSD License)
b3d2a929 54 - JsDoc Toolkit (MIT license)
00639fab 55 - stacktrace.js is public domain
b3d2a929 56
916a000e
RK
57automated tests use:
58 - auto_tests/lib/jquery-1.4.2.js (MIT & GPL2)
59 - auto_tests/lib/Asserts.js (Apache 2.0 License)
1a27bd14 60 - auto-tests/lib/JsTestDriver-1.3.3cjar (Apache 2.0 License
916a000e 61
758a629f
DV
62Linter uses:
63 - JSHint (modified MIT license; prevents evil)
64
1946f7ce 65excanvas: http://code.google.com/p/explorercanvas/
f18986e5 66yui compressor: http://developer.yahoo.com/yui/compressor/
b3d2a929 67jsdoc toolkit: http://code.google.com/p/jsdoc-toolkit/
1946f7ce 68
916a000e
RK
69jquery: http://code.jquery.com/jquery-1.4.2.js
70Asserts.js: http://www.google.com/codesearch/p?#3tsINRJRCro/trunk/JsTestDriver/src/com/google/jstestdriver/javascript/Asserts.js
71JSTestDriver: http://code.google.com/p/js-test-driver/
72
758a629f
DV
73JSHint: jshint.com
74
19e4f838 75dygraphs is available under the MIT license, included in LICENSE.txt.