Browse files

Added AUTHORS and README files

  • Loading branch information...
1 parent 9343fb9 commit 9ae16c8c44c6332c1bc107d90bda1c1ae9b12cb9 @gettalong committed Nov 21, 2009
Showing with 21 additions and 0 deletions.
  1. +1 −0 AUTHORS
  2. +20 −0 README
View
1 AUTHORS
@@ -0,0 +1 @@
+The author of kramdown is Thomas Leitner <t_leitner@gmx.at>.
View
20 README
@@ -0,0 +1,20 @@
+# kramdown
+
+kramdown is yet-another-markdown-parser but fast, pure Ruby, using a strict syntax definition and
+supporting several common extensions.
+
+The syntax definition can be found in doc/syntax.page, a quick reference in doc/quickref.page. All
+the documentation is available online at http://kramdown.rubyforge.org.
+
+# Usage
+
+kramdown has a basic *Cloth API, so using kramdown is as easy as
+
+ require 'kramdown'
+
+ Kramdown::Document.new(text).to_html
+
+
+# License
+
+See the COPYING file.

0 comments on commit 9ae16c8

Please sign in to comment.