[Pkg-javascript-commits] [d3-tip.js] 103/277: initial pass at documentation structure

[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 e74aba7d9d547ae0715b6a2ad8902221678173f0
Author: Justin Palmer <justin at github.com>
Date:   Sun Apr 21 14:06:33 2013 -0700

    initial pass at documentation structure
---
 README.md                              |  5 ++++-
 docs/home.md                           | 19 +++++++++++++++++++
 docs/positioning-tooltip.md            |  1 +
 docs/setting-tooltip-content.md        |  1 +
 docs/showing-and-hiding-tooltips.md    |  1 +
 docs/styling-and-modifying-tooltips.md |  1 +
 6 files changed, 27 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 2c3246f..238314f 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,9 @@
 
 ![](https://github-images.s3.amazonaws.com/skitch/Screen_Shot_2013-04-08_at_11.40.10_AM-20130408-114054.png)
 
+### API Docs
+[API Documentation](docs/home.md)
+
 ### Download
 * [Production Version](https://raw.github.com/Caged/d3-tip/master/d3.tip.min.js) : **3kb** / **~1kb gzipped**
 * [Development Version](https://raw.github.com/Caged/d3-tip/master/src/d3.tip.js) : **6kb** / **~2kb gzipped**
@@ -12,7 +15,7 @@ bower install Caged/d3-tip
 ```
 *Note the capital "C"*
 
-### Usage
+### Quick Usage
 ``` javascript
 
 /* Initialize tooltip */
diff --git a/docs/home.md b/docs/home.md
new file mode 100644
index 0000000..4efb07e
--- /dev/null
+++ b/docs/home.md
@@ -0,0 +1,19 @@
+# d3.tip
+d3.tip is small plugin for [d3.js](http://d3js.org) that makes it easy to add tooltips to most of your visualizations.
+
+### API
+
+#### Showing and hiding tooltips
+* tip.show
+* tip.hide
+
+#### Styling and modifying tooltips
+* tip.attr
+* tip.style
+
+### Positioning tooltips
+* tip.direction
+* tip.offset
+
+### Updating tooltip content
+* tip.html
diff --git a/docs/positioning-tooltip.md b/docs/positioning-tooltip.md
new file mode 100644
index 0000000..15f8e39
--- /dev/null
+++ b/docs/positioning-tooltip.md
@@ -0,0 +1 @@
+# Positioning tooltips
\ No newline at end of file
diff --git a/docs/setting-tooltip-content.md b/docs/setting-tooltip-content.md
new file mode 100644
index 0000000..26abb81
--- /dev/null
+++ b/docs/setting-tooltip-content.md
@@ -0,0 +1 @@
+# Setting tooltip content
\ No newline at end of file
diff --git a/docs/showing-and-hiding-tooltips.md b/docs/showing-and-hiding-tooltips.md
new file mode 100644
index 0000000..6480a24
--- /dev/null
+++ b/docs/showing-and-hiding-tooltips.md
@@ -0,0 +1 @@
+# Showing and hiding tooltips
\ No newline at end of file
diff --git a/docs/styling-and-modifying-tooltips.md b/docs/styling-and-modifying-tooltips.md
new file mode 100644
index 0000000..3587d8f
--- /dev/null
+++ b/docs/styling-and-modifying-tooltips.md
@@ -0,0 +1 @@
+# Styling and modifying tooltips
\ No newline at end of file

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