expanded readme
Chris Wanstrath chris@ozmm.org
Sat, 31 Oct 2009 00:23:40 -0700
1 files changed,
18 insertions(+),
1 deletions(-)
jump to
M
README.md
→
README.md
@@ -1,6 +1,20 @@
GitHub Markup ============= +We use this library on GitHub when rendering you README or any other +rich text file. + +Want to add your own? Check `lib/github/markups.rb` for the definition +file. + +Even if you don't know Ruby we welcome you with open arms. Check +`lib/github/commands/asciidoc2html` or `lib/github/commands/rest2html` +for examples of Python implementations. + + +Usage +----- + require 'github/markup' GitHub::Markup.render('README.markdown', "* One\n* Two")@@ -10,4 +24,7 @@ require 'github/markup'
GitHub::Markup.render(file, File.read(file)) -Don't send any pull requests until it's ready. It's not ready. +Authors +------- + +Chris Wanstrath and all of you