Include documentation in the application

1 files changed, 38 insertions, 0 deletions

diff --git a/doc/hipchat.markdown b/doc/hipchat.markdown
new file mode 100644
index 00000000..66cf9fdc
--- /dev/null
+++ b/doc/hipchat.markdown
@@ -0,0 +1,38 @@
+Hipchat integration
+===================
+
+You can send notifications to Hipchat for all projects or only for specific projects.
+
+- To send notifications for all projects, go to **Settings > Integrations > Hipchat**
+- To send notifications for only some projects, go to **Project settings > Integrations > Hipchat**
+
+Each project can send notifications to a separate room.
+
+Send notifications to a room
+-----------------------------
+
+Example of notifications:
+
+![Hipchat notification](http://kanboard.net/screenshots/documentation/hipchat-notification.png)
+
+This feature use the room notification token system of Hipchat.
+
+### Hipchat configuration
+
+![Hipchat room token](http://kanboard.net/screenshots/documentation/hipchat-room-token.png)
+
+1. Go to to **My account**
+2. Click on the tab **Rooms** and select the room you want to send the notifications
+3. On the left, choose **Tokens**
+4. Enter a label, by example "Kanboard" and save
+
+### Kanboard configuration
+
+![Hipchat settings](http://kanboard.net/screenshots/documentation/hipchat-settings.png)
+
+1. Go to **Settings > Integrations > Hipchat** or **Project settings > Integrations > Hipchat**
+2. Replace the API url if you use the self-hosted version of Hipchat
+3. Set the room name or the room API ID
+4. Copy and paste the token generated previously
+
+Now, Kanboard events will be sent to the Hipchat room.