updated README

dseifert · Jan 25, 2015 · dd1d7bb · dd1d7bb
1 parent d6826cd
commit dd1d7bb
Showing 1 changed file with 18 additions and 4 deletions.
diff --git a/README.rdoc b/README.rdoc
@@ -9,10 +9,22 @@
 
 The following macros are added:
 
-* {{note(text)}}
-* {{tip(text)}}
-* {{important(text)}}
-* {{warning(text)}}
+* note
+* tip
+* important
+* warning
+
+which can be used in one of three ways:
+
+   {{note(text with *wiki formatting*)}}
+
+   {{note
+   Alternately, you can put blocks of *wiki-formatted* text here.
+   }}
+
+   {{note(Or if you really want)
+   You can do both...
+   }}
 
 This displays a block in the wiki page with a corresponding
 icon and the specified text.
@@ -22,6 +34,8 @@ icon and the specified text.
 The icons and the stylesheet were taken from the DokuWiki Note-Plugin ((c) Olivier
 Cortès and others, http://www.dokuwiki.org/plugin:note (GPLv2)).
 
+For the contributors, please see the git commit log.
+
 == License
 
 This plugin is released under the GPLv2.