update readme

ruby · Dec 31, 2013 · a149945 · a149945
1 parent 43d3b67
commit a149945
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 33 deletions.
diff --git a/README b/README
diff --git a/README.md b/README.md
@@ -1,6 +1,14 @@
-# RedmineRdFormatter
+# Redmine RD Formatter
 
-TODO: Write a gem description
+This is a redmine plugin for supporting RD as a wiki format.
+
+## What is RD?
+
+RD(Ruby Document Format) is Ruby's POD.
+
+It is a lightweight markup language, which was commonly used in Ruby-related documents. Some of experienced Ruby programmers still love it.
+
+See [the article on Wikipedia](http://en.wikipedia.org/wiki/Ruby_Document_format) for more details.
 
 ## Installation