Converted README to Markdown

ooyala · Sep 9, 2011 · 82c5893 · 82c5893
1 parent 75424a3
commit 82c5893
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 50 deletions.
diff --git a/README b/README
diff --git a/README.md b/README.md
@@ -0,0 +1,53 @@
+# tipsy
+
+Facebook-style tooltip plugin for jQuery
+(c) 2008-2010 Jason Frame (jason@onehackoranother.com)
+Released under The MIT License.
+
+## Description:
+
+tipsy is a simple jQuery plugin for generating Facebook-style tooltips.
+
+It's used by Twitter, Github, Slideshare and Bitbucket, amongst others.
+
+## Homepage:
+
+http://onehackoranother.com/projects/jquery/tipsy
+
+## Source:
+
+Hosted at GitHub; browse at:
+
+  http://github.com/jaz303/tipsy/tree/master
+
+Or clone from:
+
+    git://github.com/jaz303/tipsy.git
+
+## Usage:
+
+1. Copy the contents of src/{images,javascripts,stylesheets} to the corresponding asset directories in your project. 
+   If the relative path of your images directory from your stylesheets   directory is not "../images", you'll need to adjust tipsy.css appropriately.
+
+2. Insert the neccesary elements in your document's <head> section, e.g.:
+
+        <script type='text/javascript' src='/javascripts/jquery.tipsy.js'></script>
+        <link rel="stylesheet" href="/stylesheets/tipsy.css" type="text/css" />
+
+ Remember to include jquery.tipsy.js *after* including the main jQuery library.
+
+3. Initialise Tipsy in your document.onload, e.g.:
+
+        <script type='text/javascript'>
+         $(function() {
+	       $('a[rel=tipsy]').tipsy({fade: true, gravity: 'n'});
+	     });
+        </script>
+
+Please refer to the docs directory for more examples and documentation.
+
+## A note on forking:
+
+By forking this project you hereby grant permission for any commits to your fork to be
+merged back into this repository and, with attribution, be released under the terms of
+the MIT License.