Skip to content

Commit

Permalink
Improve directions on the readme and do another release.
Browse files Browse the repository at this point in the history
  • Loading branch information
CharlieHess committed Sep 3, 2015
1 parent eb2f340 commit 5157ed2
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## Slack Poker Bot
A bot that turns Slack into a legitimate Texas Hold'em client. Start a game in any channel or private group with 2-10 players. PokerBot will deal hands, direct message players with their hole cards, query players (in order) for their action, determine the winning hand, and handle the pot.
A bot that turns Slack into a legitimate Texas Hold'em client. Start a game in any channel or private group with 2-10 players. PokerBot will deal hands, direct message players with their hole cards, query players for their action, determine the winning hand, and handle the pot.

![](https://s3.amazonaws.com/f.cl.ly/items/3w3k222T0A1o2e0d033Q/Image%202015-09-01%20at%2011.41.33%20PM.png)
![](https://s3.amazonaws.com/f.cl.ly/items/2a073W0Q1Y2N0O2U1i3p/Image%202015-09-01%20at%2011.39.28%20PM.png)
Expand All @@ -8,27 +8,27 @@ See it [in action](https://www.youtube.com/watch?v=Joku-PKUObE).

### Getting Started
1. Create a new [bot integration](https://my.slack.com/services/new/bot)
1. Paste the API token from your integration into `main.js` _OR_
1. Create a `token.txt` file and paste your API token there
1. `npm install`
1. `node src/main.js`
1. Follow the steps to deploy the bot to Heroku or run it locally
1. To start a game, `@<your_bot_name>: Deal`
1. To end a game, `@<your_bot_name>: Quit game`

#### Heroku

##### For the lazy:
#### One-Click Heroku
Click this button:

[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)

##### Manually:
##### Manual Heroku
1. Install [Heroku toolbelt](https://devcenter.heroku.com/articles/getting-started-with-nodejs#set-up)
1. Create new bot integration (as above)
1. Create a new bot integration (as above)
1. `heroku create`
1. `heroku config:set SLACK_POKER_BOT_TOKEN=[Slack api integration token]`
1. `heroku config:set SLACK_POKER_BOT_TOKEN=[Your API token]`
1. `git push heroku master`

#### To Run Locally
1. Create a `token.txt` file and paste your API token there
1. `npm install`
1. `node src/main.js`

### But Can It Even?
It can:
- [x] Initiate a game and poll players to join
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "slack-poker-bot",
"version": "0.0.9",
"version": "0.0.95",
"repository": "https://github.com/CharlieHess/slack-poker-bot",
"scripts": {
"start": "node src/main.js"
Expand Down

0 comments on commit 5157ed2

Please sign in to comment.