diff --git a/README.md b/README.md index 1e431b6..22bd9a9 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,22 @@ It uses a bolt db for all data storage. ## Installation +The script `package.sh` will build all plugins from source and the helperbot binary then create a tgz file in the +current directory containing: +* `helperbot` - The binary +* `helperbot.service` - A systemd service to run helperbot (You WILL need to customize this to your needs) +* `plugins/` - The directory containing the compiled plugins source + +Just copy that archive to the server you want to run it on and extract it where you want it. +Run the binary manually the first time, to trigger the setup walkthrough stuff. + On first run, the app will prompt the user for: * Slack Token: The bot uses this to connect to your slack * Admin User DM ID: This is the 'admin users' DM ID, it's a 9 character Slack ID that starts with a `D`. This is the Direct Message ID for the admin user. +Use `Ctrl-C` to quit. + ## Included Plugins: ### Advent of Code