diff --git a/README.md b/README.md new file mode 100644 index 0000000..18ffe8c --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +# Redmine Wiki Notes Plugin + +## Plugin installation + +1. Copy the plugin directory into the vendor/plugins directory + +2. Update your gems + +3. Restart Redmine + +## Usage + +The following macros are added: + +- note +- tip +- important +- warning + +Which can be used in three ways: + +~~~ +{{note(Note with *wiki formatting*)}} + +{{note +Alternately, you can put blocks of *wiki-formatted* text here. +}} + +{{note(Or if you really want) +You can do both... +}} + +{{tip +This is a tip +}} + +{{warning +Be carefull with : +* razors +* knifes +* fire +}} + +{{important +This is important message. Heed my words. +}} +~~~ + +![Screenshot](screenshot.png?raw=true "Screenshot") + +## Credits + +The icons and the stylesheet were taken from the DokuWiki Note-Plugin (© Olivier +Cortès and others, https://www.dokuwiki.org/plugin:note (GPLv2)). + +For the contributors, please see the git commit log. + +## License + +This plugin is released under the GPLv2. + diff --git a/README.rdoc b/README.rdoc deleted file mode 100644 index d397f5b..0000000 --- a/README.rdoc +++ /dev/null @@ -1,41 +0,0 @@ -= Redmine Wiki Notes Plugin - -== Plugin installation - -1. Copy the plugin directory into the vendor/plugins directory -2. Restart Redmine - -== Usage - -The following macros are added: - -* 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. - -== Credits - -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.