From 3cf46b63b1c372e0215b42a6ce198e40c7806d04 Mon Sep 17 00:00:00 2001 From: Alex Huddleston Date: Fri, 28 Jun 2019 01:12:03 +0000 Subject: [PATCH] Update readme. --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2396c99..7c8ed03 100644 --- a/README.md +++ b/README.md @@ -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"