switch to YUI compressor for making packed JS -- 49k -> 42k

[dygraphs.git] / README
diff --git a/README b/README

index abb225c..6248472 100644 (file)
--- a/README
+++ b/README
@@ -1,8 +1,10 @@
  dygraphs JavaScript charting library
  Copyright (c) 2006-, Dan Vanderkam.
  http://code.google.com/p/dygraphs/
+http://github.com/danvk/dygraphs
  
-The dygraphs JavaScript library produces produces interactive, zoomable charts of time series based on CSV files.
+
+The dygraphs JavaScript library produces produces interactive, zoomable charts of time series.
  
  Features
  - Plots time series without using an external server or Flash
@@ -12,10 +14,7 @@ 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/
@@ -26,17 +25,14 @@ 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"
        );
  </script>
  </body>
@@ -44,8 +40,14 @@ Minimal Example
  
  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)
+
+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/
  
  dygraphs is available under the MIT license, included in LICENSE.txt.