ada/slack-bot-testing
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update readme.

Browse source
This commit is contained in:
Alex Huddleston 2019-06-28 01:12:03 +00:00
parent 940d888b46
commit 3cf46b63b1
1 changed files with 13 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -1,7 +1,19 @@
# UP Hype Bot
A Slack bot written in Python to gets HYPED on that Unified Platform
## CF Functionality
## Usage
Firstly, this bot was written using BASH so I'm unsure how well this will run on Windows. I'm currently running it on a Google Cloud Platform free tier VPS.
Clone this repo, then make sure you have the `slackclient` module installed in your python environment.
You will need an API token from Slack, you can learn that and more on how to set up a bot from this documentation: https://github.com/slackapi/python-slackclient/blob/master/tutorial/01-creating-the-slack-app.md
Once you have set up and installed your app/bot, you can run it by typing:
`./runner.sh`
The bot should automatically put itself in the background, currently the only way to kill it is either to execute a `kill` command or use something like `htop` to kill the process.
## Features
### CF Functionality
Simply make any post in the chat that contains a C-word followed immediately with an F-word and the bot will quickly and efficiently remind you of what CF stands for.
This functionality ignores cases and can optionally be triggered with "CF"