doc: Added the usage section to the doc
[redmine_snipt:redmine_snipt.git] / README.rdoc
1 == Snipt Plugin
2
3 Redmine plugin to add the wiki macro __snipt__ to embed snippets from a
4 Snipt server into a wiki page.
5
6 Snipt is a Open Source project hosted at {Github}[https://github.com/lionburger/snipt]
7 and the main server at {Snipt}[http://snipt.net]. Currently the plugin use this
8 main server to get the snippets.
9
10 == Features
11
12  * Embed a plugin hosted at http://snipt.net into a Redmine's wiki page.
13  * Link with the original ne at snitp.net.
14
15 == Getting the plugin
16
17 The plugin's code can be found in the at {Gitorious}[http://gitorious.org/redmine_snipt/redmine_snipt].
18
19 == Install
20
21 1. Copy the plugin to vendor/plugins/redmine_snipt
22 2. Restart your Redmine web servers (e.g. mongrel, thin, mod_rails)
23
24 == Usage
25
26 For using the feature you need to add the wiki macro __snipt__ with the
27 snipt id at the Snipt server (i.e. http://snipt.net).
28 For example:
29 {{snipt(21884)}}
30
31 == License
32
33 This plugin is licensed under the GNU GPL v2.  See LICENSE.txt for details.
34 Note: the included code from the rubycas-client library is licensed under the LGPL v2.1.
35
36 == Project help
37
38 If you need help you can contact the maintainer on the bug tracker at http://forja.cenatic.es
39
40