Fix bug 428, add test which catches exception. What an annoying little bug.
[dygraphs.git] / README
diff --git a/README b/README
index abb225c..1dfd239 100644 (file)
--- a/README
+++ b/README
@@ -1,8 +1,13 @@
 dygraphs JavaScript charting library
 Copyright (c) 2006-, Dan Vanderkam.
-http://code.google.com/p/dygraphs/
 
-The dygraphs JavaScript library produces produces interactive, zoomable charts of time series based on CSV files.
+Documentation: http://dygraphs.com/
+Support: http://groups.google.com/group/dygraphs-users
+Source: http://github.com/danvk/dygraphs
+Issues: http://code.google.com/p/dygraphs/
+
+
+The dygraphs JavaScript library produces interactive, zoomable charts of time series.
 
 Features
 - Plots time series without using an external server or Flash
@@ -12,13 +17,10 @@ Features
 - Interactive zoom
 - Adjustable averaging period
 - Customizable click-through actions
-
-Caveats
-- Requires Firefox 1.5+ or Safari/WebKit? 1.3+.
-- Internet Explorer is poorly supported.
+- Compatible with the Google Visualization API
 
 Demo
-For a gallery and documentation, see http://danvk.org/dygraphs/
+For a gallery and documentation, see http://dygraphs.com/
 
 Minimal Example
 <html>
@@ -26,26 +28,51 @@ Minimal Example
 <script type="text/javascript" src="dygraph-combined.js"></script>
 </head>
 <body>
-<div id="graphdiv" style="width:400px; height:300px;"></div>
+<div id="graphdiv"></div>
 <script type="text/javascript">
-  g = new DateGraph(
+  g = new Dygraph(
         document.getElementById("graphdiv"),  // containing div
-        function() {                // function or path to CSV file.
-          return "20080507,75\n" +
-                 "20080508,70\n" +
-                 "20080509,80\n";
-        },
-        [ "Temperature" ],          // names of data series
-        {}                          // additional options (see wiki)
+        "Date,Temperature\n" +                // the data series
+        "2008-05-07,75\n" +
+        "2008-05-08,70\n" +
+        "2008-05-09,80\n",
+        { }                                   // the options
       );
 </script>
 </body>
 </html>
 
+Making Changes
+If you've made a change to dygraphs and would like to contribute it back to the
+community, please follow the guide at http://dygraphs.com/changes.html.
+
 License(s)
 dygraphs uses:
- - MochiKit (MIT License)
- - PlotKit (BSD License)
+ - rgbcolor.js (Public Domain)
+ - strftime.js (BSD License)
  - excanvas.js (Apache License)
+ - YUI compressor (BSD License)
+ - JsDoc Toolkit (MIT license)
+ - stacktrace.js is public domain
+
+automated tests use:
+ - auto_tests/lib/jquery-1.4.2.js (MIT & GPL2)
+ - auto_tests/lib/Asserts.js (Apache 2.0 License)
+ - auto-tests/lib/JsTestDriver-1.3.3cjar (Apache 2.0 License
+
+Linter uses:
+ - JSHint (modified MIT license; prevents evil)
+
+rgbcolor: http://www.phpied.com/rgb-color-parser-in-javascript/
+strftime: http://tech.bluesmoon.info/2008/04/strftime-in-javascript.html
+excanvas: http://code.google.com/p/explorercanvas/
+yui compressor: http://developer.yahoo.com/yui/compressor/
+jsdoc toolkit: http://code.google.com/p/jsdoc-toolkit/
+
+jquery: http://code.jquery.com/jquery-1.4.2.js
+Asserts.js: http://www.google.com/codesearch/p?#3tsINRJRCro/trunk/JsTestDriver/src/com/google/jstestdriver/javascript/Asserts.js
+JSTestDriver: http://code.google.com/p/js-test-driver/
+
+JSHint: jshint.com
 
 dygraphs is available under the MIT license, included in LICENSE.txt.