1GitHub Markup
 2=============
 3
 4We use this library on GitHub when rendering you README or any other
 5rich text file.
 6
 7Want to add your own? Check `lib/github/markups.rb` for the definition
 8file.
 9
10Even if you don't know Ruby we welcome you with open arms. Check
11`lib/github/commands/asciidoc2html` or `lib/github/commands/rest2html`
12for examples of Python implementations.
13
14
15Usage
16-----
17
18    require 'github/markup'
19    GitHub::Markup.render('README.markdown', "* One\n* Two")
20
21Or, more realistically:
22
23    require 'github/markup'
24    GitHub::Markup.render(file, File.read(file))
25
26
27Contributing
28------------
29
301. Fork it.
312. Create a branch
323. Commit your changes
334. Push to the branch
345. Create an [Issue][1] with a link to your branch
356. Enjoy a refreshing Diet Coke and wait
36
37
38Authors
39-------
40
41Chris Wanstrath and all of you
42
43[1]: http://github.com/defunkt/github_markup/issues