Skip to content

Commit

Permalink
Added instructions for installing the package and running it
Browse files Browse the repository at this point in the history
  • Loading branch information
clamytoe committed Jan 9, 2018
1 parent abb7339 commit 5ae75e5
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,19 @@ conda env create -f environment.yml
source activate bdaybot
```

### Package Installation

```bash
python setup.py install
```

### How to use
Before you can start the bot you are going to have to set a couple of environment variables on your system:

**BOT_ID** and **SLACK_BOT_TOKEN**

To start it simply use the command `bdaybot`

Once the bot is up and running and you've added it to one of your slack channels, it'll simply respond to any message directed towards it. It's not smart, any message to it should contain the **birthday** keyword.

![sample](img/bday_sample.png)
Expand Down

0 comments on commit 5ae75e5

Please sign in to comment.