README.md
1# DokuWiki-Hipchat
2
3A DokuWiki plugin that notifies a HipChat room of wiki edits.
4
5Setup
6-----
7
81. Clone repository into your DokuWiku plugins folder, making the target folder name 'hipchat'
9
10```
11$ git clone https://github.com/jaguardesignstudio/dokuwiki-hipchat.git hipchat
12```
13
142. To fetch the required dependencies, run:
15
16```
17$ composer install
18```
19
203. In your DokuWiki Configuration Settings, enter an API token, room name (or ID number), and the name you want the notifications to appear from in HipChat.
21
224. Optionally, you can also define a comma-separated list of first-level namespaces to limit notifications to only those namespaces (without this setting, all namespaces will trigger notifications)
23
24Requirements
25------------
26
27* DokuWiki
28* Hippy - [mandatory] PHP version 5.x (developed using 5.2.9)
29* Hippy - [mandatory] PHP's cURL module
30