mirror of
https://github.com/Mibew/mibew_slack.git
synced 2025-02-02 07:04:41 +03:00
Added in README
This commit is contained in:
parent
58f9d640e0
commit
138db8d294
52
README.md
52
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 `<Mibew root>/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 "`<Mibew root>`/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)
|
||||
|
Loading…
Reference in New Issue
Block a user