Skip to content

Commit

Permalink
Updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jdewinne committed Nov 30, 2017
1 parent 800da0a commit ec93b71
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Preface #
# Preface

This document describes the functionality provided by the XL Release Flowdock plugin.

Expand All @@ -22,24 +22,29 @@ See the [XL Release Documentation](https://docs.xebialabs.com/xl-release/) for b



# Overview #
## Overview

The XL Release Flowdock plugin is a XL Release plugin that adds capability for sending message to a Flowdock inbox.

# Requirements #
## Requirements

* **Requirements**
* **XL Release** 6.0.x+

# Installation #
## Installation

Place the plugin JAR file into your `SERVER_HOME/plugins` directory.

# Usage #
## Usage

### Event based notifications

1. Go to `Settings - Shared configuration - Flowdock: Configuration`
2. Add a new configuration
3. Provide Title (Can be anything), API url (eg: https://api.flowdock.com), Flow token (See your Flow configuration in Flowdock) and enable or disable the Flowdock configuration.
![Flowdock configuration](images/Flowdock_configuration.png?raw=true "Flowdock configuration")
4. Each time XL Release stores something into the Activity logs, this will also be send to Flowdock.

### Tasks

+ SendTeamInboxMessage: Allows to send a specific message to a TeamInbox.

0 comments on commit ec93b71

Please sign in to comment.