Add unit test to detect the "unwanted draw point"

[dygraphs.git] / README.md

diff --git a/README.md b/README.md
index d341a4f..9abb9a1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,8 +1,9 @@
+[![Build Status](https://travis-ci.org/danvk/dygraphs.svg?branch=markdown-readme)](https://travis-ci.org/danvk/dygraphs) [![Coverage Status](https://img.shields.io/coveralls/danvk/dygraphs.svg)](https://coveralls.io/r/danvk/dygraphs)
 # dygraphs JavaScript charting library
 
 The dygraphs JavaScript library produces interactive, zoomable charts of time series:
 
-(image)
+<img src="https://cloud.githubusercontent.com/assets/98301/5311286/eb760eea-7c10-11e4-9a59-1d144e51a15b.png" width="618" height="322">
 
 Learn more about it at [dygraphs.com](http://www.dygraphs.com).
 
@@ -13,7 +14,7 @@ Get help with dygraphs on
 ## Features
 * Plots time series without using an external server or Flash
 * Supports [error bands](http://dygraphs.com/tests/legend-values.html) around data series
-* [Interactive zoom](http://dygraphs.com/tests/link-interaction.html)
+* Interactive [pan and zoom](http://dygraphs.com/tests/link-interaction.html)
 * Displays values [on mouseover](http://dygraphs.com/tests/legend-values.html)
 * Adjustable [averaging period](http://dygraphs.com/tests/temperature-sf-ny.html)
 * Extensive set of [options](http://www.dygraphs.com/options.html) for customization.
@@ -45,20 +46,16 @@ Learn more by reading [the tutorial](http://www.dygraphs.com/tutorial.html) and
 seeing demonstrations of what dygraphs can do in the
 [gallery](http://www.dygraphs.com/gallery).
 
-## Making Changes
-If you've made a change to dygraphs and would like to contribute it back to the
-community, please follow the [Guide to making dygraphs
-changes](http://dygraphs.com/changes.html).
+## Development
 
-## License(s)
-dygraphs uses:
- - UglifyJS (BSD License)
- - JsDoc Toolkit (MIT license)
- - console-polyfill (MIT license)
+To get going, clone the repo and run:
+
+    npm install
+    npm run build
 
-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)
+Then open `tests/demo.html` in your browser.
 
+Read more about the dygraphs development process in the [developer guide](/DEVELOP.md).
+
+## License(s)
 dygraphs is available under the MIT license, included in LICENSE.txt.