Skip to content
This repository
Browse code

Merge pull request #75 from okonski/markdown_readme

Rewritten README to use Markdown
  • Loading branch information...
commit 9fe119e27f31870ae58cfd3faa4871d0738deff6 2 parents 75424a3 + ab6888a
Jason Frame authored

Showing 2 changed files with 55 additions and 50 deletions. Show diff stats Hide diff stats

  1. +0 50 README
  2. +55 0 README.md
50 README
... ... @@ -1,50 +0,0 @@
1   -tipsy - Facebook-style tooltip plugin for jQuery
2   - (c) 2008-2010 Jason Frame (jason@onehackoranother.com)
3   - Released under The MIT License.
4   -
5   -== DESCRIPTION:
6   -
7   -tipsy is a simple jQuery plugin for generating Facebook-style tooltips.
8   -
9   -It's used by Twitter, Github, Slideshare and Bitbucket, amongst others.
10   -
11   -== HOMEPAGE:
12   -
13   -http://onehackoranother.com/projects/jquery/tipsy
14   -
15   -== SOURCE:
16   -
17   -Hosted at GitHub; browse at:
18   -
19   - http://github.com/jaz303/tipsy/tree/master
20   -
21   -Or clone from:
22   -
23   - git://github.com/jaz303/tipsy.git
24   -
25   -== USAGE:
26   -
27   -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.
28   -
29   -2. Insert the neccesary elements in your document's <head> section, e.g.:
30   -
31   -<script type='text/javascript' src='/javascripts/jquery.tipsy.js'></script>
32   -<link rel="stylesheet" href="/stylesheets/tipsy.css" type="text/css" />
33   -
34   -Remember to include jquery.tipsy.js *after* including the main jQuery library.
35   -
36   -3. Initialise Tipsy in your document.onload, e.g.:
37   -
38   -<script type='text/javascript'>
39   - $(function() {
40   - $('a[rel=tipsy]').tipsy({fade: true, gravity: 'n'});
41   - });
42   -</script>
43   -
44   -Please refer to the docs directory for more examples and documentation.
45   -
46   -== A NOTE ON FORKING:
47   -
48   -By forking this project you hereby grant permission for any commits to your fork to be
49   -merged back into this repository and, with attribution, be released under the terms of
50   -the MIT License.
55 README.md
Source Rendered
... ... @@ -0,0 +1,55 @@
  1 +# tipsy
  2 +
  3 +Facebook-style tooltip plugin for jQuery
  4 +
  5 +(c) 2008-2010 Jason Frame (jason@onehackoranother.com)
  6 +
  7 +Released under The MIT License.
  8 +
  9 +## Description:
  10 +
  11 +tipsy is a simple jQuery plugin for generating Facebook-style tooltips.
  12 +
  13 +It's used by Twitter, Github, Slideshare and Bitbucket, amongst others.
  14 +
  15 +## Homepage:
  16 +
  17 +http://onehackoranother.com/projects/jquery/tipsy
  18 +
  19 +## Source:
  20 +
  21 +Hosted at GitHub; browse at:
  22 +
  23 + http://github.com/jaz303/tipsy/tree/master
  24 +
  25 +Or clone from:
  26 +
  27 + git://github.com/jaz303/tipsy.git
  28 +
  29 +## Usage:
  30 +
  31 +1. Copy the contents of src/{images,javascripts,stylesheets} to the corresponding asset directories in your project.
  32 + If the relative path of your images directory from your stylesheets directory is not "../images", you'll need to adjust tipsy.css appropriately.
  33 +
  34 +2. Insert the neccesary elements in your document's `<head>` section, e.g.:
  35 +
  36 + <script type='text/javascript' src='/javascripts/jquery.tipsy.js'></script>
  37 + <link rel="stylesheet" href="/stylesheets/tipsy.css" type="text/css" />
  38 +
  39 + Remember to include jquery.tipsy.js *after* including the main jQuery library.
  40 +
  41 +3. Initialise Tipsy in your document.onload, e.g.:
  42 +
  43 + <script type='text/javascript'>
  44 + $(function() {
  45 + $('a[rel=tipsy]').tipsy({fade: true, gravity: 'n'});
  46 + });
  47 + </script>
  48 +
  49 +Please refer to the docs directory for more examples and documentation.
  50 +
  51 +## A note on forking:
  52 +
  53 +By forking this project you hereby grant permission for any commits to your fork to be
  54 +merged back into this repository and, with attribution, be released under the terms of
  55 +the MIT License.

0 comments on commit 9fe119e

Please sign in to comment.
Something went wrong with that request. Please try again.