Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Converted README to Markdown

  • Loading branch information...
commit 82c589355663e5c3459a7b4867aef97eeee94579 1 parent 75424a3
@pokonski pokonski authored
Showing with 53 additions and 50 deletions.
  1. +0 −50 README
  2. +53 −0 README.md
View
50 README
@@ -1,50 +0,0 @@
-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.
View
53 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.
Please sign in to comment.
Something went wrong with that request. Please try again.