convert readme to rst, explain usage

kenichiro22 · Nov 23, 2011 · 73f29e5 · 73f29e5
1 parent 99ba9d1
commit 73f29e5
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 13 deletions.
diff --git a/README.rst b/README.rst
@@ -0,0 +1,22 @@
+==============================================================
+Convert reStructuredText to Confluence markup
+==============================================================
+
+Supported directives
+====================
+
+* bullet list
+* enumerated list
+* note, warning
+* image
+* definition list
+* simple table
+* block quote
+* text effect
+   * strong
+   * emphasis
+
+Usage
+=====
+::
+    ./src/rst2confluence.py /path/to/file.rst
diff --git a/README.txt b/README.txt