diff --git a/README.md b/README.md new file mode 100644 index 0000000..d99333b --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +SLACK BIBLE BOT +================== + +Setting this up with [Slack](https://slack.com/) is simple. + +In your "Integration Settings" add an **Outgoing WebHooks** entry with these parameters: + + - Channel : Up to your discretion. It is highly recommended you limit to a specific channel. If you are not quite sure just choose '#random'. + - Trigger Word(s) : In this version the only words that will be recognized are 'bible','gospel,'scripture'. Based on recommendations (Pull Requests) there may be more added later. + - URL(s) : this **must be** 'https://disciplr.herokuapp.com/bible'. This, again, is likely to change in future releases but I expect to maintain backward-compatibility. + - Token : This should be unchanged and can be ignored + - Descriptive Label : This is also up to your discretion but I recommend 'Bible Verse Expert' + - Customize Name : 'god' + - Customize Icon : I _really_ like the 'church' icon + +Click "Save Settings" and you are ready to go. + +![Integration Settings](integration_settings.png?raw=true) + +![Chuch Emoji](church_emoji.png?raw=true) + +In [Slack](https://slack.com/) you simply type something like `bible John 3:16` and will get a response like this + +![John 3:16](bible_verse.png?raw=true) + +--- + +Acknowledgement and thanks to [GetBible.net](http://getbible.net/api) for their API that provides the scripture. I have built this in a modular fashion, though, in order to allow *other* sources if desired. diff --git a/bible_verse.png b/bible_verse.png new file mode 100644 index 0000000..b4d753f Binary files /dev/null and b/bible_verse.png differ diff --git a/church_emoji.png b/church_emoji.png new file mode 100644 index 0000000..44af244 Binary files /dev/null and b/church_emoji.png differ diff --git a/integration_settings.png b/integration_settings.png new file mode 100644 index 0000000..8f649e7 Binary files /dev/null and b/integration_settings.png differ