Updated README

README.md

@@ -55,6 +55,7 @@ A chatbot for Owncast, enabling viewers to accumulate points which can be used t
 ## Roadmap
 *Not necessarily in this order*
 * Kofi monthly subscription benefits
+ * Subscriber-only emojis, monthly points awards, etc.
 * Get emojis in OwnchatBot panels working correctly, because my partner insists on it
 * Audible sound when a goal is reached
 * Streak tracker, to track how many consecutive streams a viewer has watched, and reward accordingly
@@ -88,34 +89,15 @@ Descend into the OwnchatBot directory. Run:
   ```
 If you installed by downloading from the repo, rather than doing a git clone, simply download the new version and extract the file over your existing installation.
 
-### Update the database
+### Run the update script
+This will make any necessary upgrades to your existing database and config files.
 Run:
   ```bash
-  bash update-db.sh
+  bash update.sh
   ```
 
 ## Running OwnchatBot
-### Running in Flask's native server
-Port 8081 is used here as an example. Be sure to set a correct, usable port number.
-
-Set the FLASK_APP variable:
-```bash
-export FLASK_APP=ownchatbot
-```
-Run the bot in debug mode:
-*For the love of whatever it is that you personally find holy, don't run it this way in production*
-```bash
-env/bin/python -m flask --debug run --host=0.0.0.0 -p 8081
-```
-Run the bot:
-```bash
-env/bin/python -m flask run --host=0.0.0.0 -p 8081
-```  
-### Running in Gunicorn
-Set the FLASK_APP variable:
-```bash
-export FLASK_APP=ownchatbot
-```
+*Port 8081 used here as an example. Change it to whatever port you'd like your bot to listen on.*
 Run OwnchatBot:
 ```bash
 env/bin/python -m gunicorn -b 0.0.0.0:8081 -w 1 'ownchatbot:create_app()'
@@ -130,11 +112,11 @@ env/bin/python -m gunicorn --error-logfile ownchatbot.log -b 0.0.0.0:8081 -w 1 '
 ## Final configuration
 Once OwnchatBot is running, you can start setting up your rewards and other options via the Management Panel. When you finish running init-ocb.sh, it gives you a URL for your management panel. It will look something like this, with a proper, pregenerated auth code attached to it.
 
-http://localhost:8081/mgmt?auth=yourMGMT_AUTHcode
+http://localhost:<your_port>/mgmt?auth=yourMGMT_AUTHcode
 
 Once you're in the OwnchatBot management panel, bookmark it.
 
-The first thing you'll want to visit is the settings page. Each option is explained in detail. Then you'll need to get it talking to your Owncast instance, and Kofi if you'll be using it, covered below.
+The first thing you'll want to visit is the settings page. Each option is explained in detail. Then you'll need to get it talking to your Owncast instance, and Kofi if you'll be using it, both covered below.
 
 ### Owncast chat connection
 OwnchatBot accesses Owncast chat room information via a webhook. You'll need to point Owncast at that webhook for things to function.
@@ -149,34 +131,37 @@ You need to create a button on your Owncast page, so your viewers can access the
 
 1. Go to your Owncast Admin panel -> Integrations -> External Actions.
 2. Click on "Create New Action"
-3. Set the second field to your external OwnchatBot server address, and the port you set up in the "Running OwnchatBot" section.
+3. Set the second field to your external OwnchatBot server address, and the port you set up in the "Running OwnchatBot" section, with `/userpanel` appended.
+    Example:
+    ```
+    https://<your_external.ownchatbot.url>/userpanel
+    ```
 4. Set the third field (action title) to whatever you want the button to be named.
     Example:
     ```
-    http://external.ownchatbot.url/userpanel
     Action Title: Stream Rewards
     ```
 5. Configure the remaining fields/options as desired.
 
 ### Kofi Integration
-Integration is accomplished via a webhook triggered by Kofi every time a donation is made.
+Integration is accomplished via a webhook triggered by Kofi every time a donation is made. Again, this webhook is your external OwnchatBot server address with `/kofiHook` appended.
 
-Paste the following webhook into Kofi -> More -> API -> Webhooks -> Webhook URL.
+Paste the webhook address into Kofi -> More -> API -> Webhooks -> Webhook URL.
   ```
-  https://external.ownchatbot.url/kofiHook
+  https://<your_external.ownchatbot.url>/kofiHook
   ```
 
 Click "Update", but stay on this page.
 
-You need a verification token which Kofi will send when it triggers the webhook.
+You need the verification token the Kofi to send when it triggers the webhook.
 Below "Webhook URL", click on "Advanced".
 A pre-generated token will already be there. Copy that token, and paste it into the OCB Management Panel -> Settings -> Kofi Integration -> Verification Token. Then click "Save Changes".
 
 OwnchatBot associates viewer accounts with Kofi accounts using their email address. So in order for viewers to get Kofi benefits in-stream, they must enter their email address in OwnchatBot viewer panel -> OwnchatBot Info -> Kofi. It **must** be the same email address associated with their Kofi account.
 
-If a viewer donates before entering their email address, OwnchatBot creates a temporary entry with their email and donation amount, and then applies it once the viewer enters their email address into the viewer panel. If there is any sort of mix-up here, the streamer can manually connect the viewer's email and account via the management panel.
+If a viewer donates before entering their email address, OwnchatBot creates a temporary entry with their email and donation amount, and then applies it once the viewer enters their email address into the viewer panel. If there is any sort of mix-up here, the streamer can manually connect the viewer's email and account via the management panel by entering the email into the viewers account. OwnchatBot will do the merge automatically.
 
-Email addresses are **ONLY** used for Kofi integration. They are not sent to any other individual or company, and will not be used to create or send mailing lists of any kind.
+Email addresses are **ONLY** used for Kofi integration. They are not sent to any other individual or company, will not be used to create or send mailing lists of any kind, or for any other purposes. Ever.
 
 ### Overlays
 To display vote and goal progress on-screen, in your stream, you need to create two browser sources in your streaming software.