From 7b5bf02b3c641f6d616753848e92b7b5a6651404 Mon Sep 17 00:00:00 2001 From: Alper Sarikaya Date: Fri, 23 Sep 2016 12:35:18 -0500 Subject: [PATCH] Update description in README.md Updating description and adding link to GitHub project page with live example. --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1a40a22..667ee20 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ # d3-twodim -Helps create two-dimensional representations of data using scatter plots (using SVG, Canvas, or WebGL), and (in the future) techniques such as Splatterplots and subsampled scatterplots. This reusable component uses a factory design pattern to keep d3-twoDim components linked to interchange data and object state. +d3-twodim is a **D3.v3.js** module for creating two-dimensional representations of data for end-user exploration. Currently, d3-twodim can instantiate scatterplots using SVG, Canvas, or WebGL, and will (in the future) instantiate visualization techniques such as Splatterplots and subsampled scatterplots. This module uses a factory design pattern to keep d3-twodim components linked to one another in order to interchange data, data item state, and user interaction. -This project is under active development. Please feel free to file an issue, open a pull request, or [contact the author](http://twitter.com/yelperalp/) with any feedback. If you use d3-twodim in your own project, [we would love to hear about it](http://twitter.com/yelperalp)! +This project is under active development. Please feel free to [file an issue](https://github.com/uwgraphics/d3-twodim/issues), open a pull request, or [contact the author](http://twitter.com/yelperalp/) with any feedback. If you use d3-twodim in your own project, [we would love to hear about it](http://twitter.com/yelperalp)! ![An example instantiation of d3-twodim](examples/simpleExample.png) +[**View a live example on the GitHub-hosted project page**](http://uwgraphics.github.io/d3-twodim/), or build the source and navigate to the `examples/` folder in a webserver. + ## Installing Download the [latest release](https://github.com/uwgraphics/d3-twodim/releases/latest), and include d3-twodim as a script source after including d3.v3.js. Otherwise, you can modify and rebuild the library by calling `npm install` from the project root.