[Pkg-javascript-commits] [d3-tip.js] 85/277: update README to reflect new reality

[bhuvan krishna]

This is an automated email from the git hooks/post-receive script.

bhuvan-guest pushed a commit to branch master
in repository d3-tip.js.

commit f406264d9239f372412115f3e830a35967334671
Author: Justin Palmer <justin at github.com>
Date:   Mon Apr 8 11:43:22 2013 -0700

    update README to reflect new reality
---
 README.md | 23 +++++------------------
 1 file changed, 5 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index 592ee17..65692b3 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,7 @@
-## Simple SVG Tooltips for d3.js - ALPHA QUALITY
+## d3.tip: Tooltips for d3-based visualizations
 
-Pure SVG tooltips for [d3.js](http://mbostock.github.com/d3/). ~3kb compressed, ~7k original.
+![](https://github-images.s3.amazonaws.com/skitch/Screen_Shot_2013-04-08_at_11.40.10_AM-20130408-114054.png)
 
-![](http://dl.dropbox.com/u/602885/d3-tip-1.png)
-
-* Familiar API - Modeled after the d3 API.
-* SVG - It's all svg, no hacks
-* Text only - Currently supports simple text values in tooltips
-* Styleable - Use any svg styling support (dashed borders, etc).
 
 ### Usage
 ``` javascript
@@ -15,6 +9,7 @@ Pure SVG tooltips for [d3.js](http://mbostock.github.com/d3/). ~3kb compressed,
 tip = d3.svg.tip().text(function(d) { return d; });
 
 // Usage
+vis.call(tip)
 vis.selectAll('rect')
   .data(data)
 .enter().append('rect')
@@ -22,14 +17,6 @@ vis.selectAll('rect')
   .attr('height', function(d) { return h - y(d) })
   .attr('y', function(d) { return y(d) })
   .attr('x', function(d, i) { return x(i) })
-  .on('mouseover', tip)
+  .on('mouseover', tip.show)
+  .on('mouseout', tip.hide)
 ```
-
-## TODO
-* ~~Left orientation~~
-* ~~Right orientation~~
-* ~~Reorient when tip exceeds document bounds~~
-* ~~docs~~
-* Auto orientation
-* svg content in tip
-* type - specify if tooltip is sticky.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/d3-tip.js.git