From 138db8d294b27ce2c0445cd22ed17614b6543a65 Mon Sep 17 00:00:00 2001 From: Derek McDaniel Date: Thu, 26 Jan 2017 21:43:40 -0500 Subject: [PATCH] Added in README --- README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 50 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 718ee37..095f5b3 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,50 @@ -# mibew_slack -Mibew Slack Plugin +# Mibew Slack plugin + +Provides Slack notifications when initiate a chat + +## Installation + +1. Get the archive with the plugin sources. At the moment the only option is to build the plugin from sources or grab it from the zip file. + +2. Untar/unzip the plugin's archive. + +3. Put files of the plugins to the `/plugins` folder. + +4. Obtain a webhook key from Slack. Go to slack, open your app directory, click on Manage, click on Custom Integrations + +5. Click on App Configuration. Choose the channel it should post to, click on Add Incoming Webhook Integration + +6. Copy the Webhook URL + +7. Add plugins config to plugins structure like below. + + ```yaml + plugins: + "Mibew:Slack": # Plugin's configurations are described below + username: "Username you will post as" + channel: "Channel to post in" + slack_url: "Webhook URL from Setup Instructions in Slack" + + ``` + + +## Plugin's configurations + +The plugin can be configured with values in "``/configs/config.yml" file. + +## Build from sources + +There are several actions one should do before use the latest version of the plugin from the repository: + +1. Obtain a copy of the repository using `git clone`, download button, or another way. +2. Install [node.js](http://nodejs.org/) and [npm](https://www.npmjs.org/). +3. Install [Gulp](http://gulpjs.com/). +4. Install npm dependencies using `npm install`. +5. Run Gulp to build the sources using `gulp default`. + +Finally `.tar.gz` and `.zip` archives of the ready-to-use Plugin will be available in `release` directory. + + +## License + +[Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)