Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
warlordofmars committed Feb 11, 2019
1 parent a0a295e commit 9fbfe1b
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,38 @@ gradle-slack-liveupdate
[![](https://jitpack.io/v/warlordofmars/gradle-slack-liveupdate.svg)](https://jitpack.io/#warlordofmars/gradle-slack-liveupdate)

![](https://i.imgur.com/AmrJprI.gif)

Overview
--------
Gradle Plugin to provide build status updates to Slack in real-time as Gradle executes through tasks

Setup
-----

To use this plugin, the following buildscript repositories and dependencies must be configured:

```
buildscript {
repositories {
maven { url 'https://jitpack.io' }
}
dependencies {
classpath 'com.github.warlordofmars:gradle-cloudformation-helper:release-0.3.9'
}
}
```

Then to apply the plugin:

```
apply plugin: 'com.github.warlordofmars.gradle.slack'
```

To configure:

```
slack {
channel '<slack_channel>'
token '<slack_api_token>'
}
```

0 comments on commit 9fbfe1b

Please sign in to comment.