Skip to content

Commit

Permalink
Added README file to describe and explain
Browse files Browse the repository at this point in the history
  • Loading branch information
ParkinT committed Nov 22, 2015
1 parent e7daf51 commit 119a34c
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions 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.
Binary file added bible_verse.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added church_emoji.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added integration_settings.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 119a34c

Please sign in to comment.