Reworded and reorganized to accommodate GiveButter instructions.

README.md

@@ -11,7 +11,9 @@ A feature rich chatbot for Owncast.
 - [Upgrading](#upgrading)
 - [Running OwnchatBot](#running-ownchatbot)
 - [Final Configuration](#final-configuration)
+* [Donations](#donations)
 - [Kofi Integration](#kofi-integration)
+- [GiveButter Integration](#givebutter-integration)
 - [Overlays](#overlays)
 - [To-do List](#to-do-list)
 - [Alerts](#alerts)
@@ -40,8 +42,8 @@ A feature rich chatbot for Owncast.
  * Add/edit/remove rewards and reward categories.
  * Viewer management for manually adjusting viewers' points.
  * A queue manager, where the streamer can mark rewards fulfilled as they go, or refund rewards if needed.
-* Kofi integration.
- * Your viewers can get points for donating via Kofi, and as part of their monthly Kofi membership.
+* Kofi and GiveButter integration.
+ * Your viewers can get points for donating via Kofi or GiveButter, and as part of their monthly Kofi membership.
 * To-do list. Add tasks and cross them off as you complete them.
  * Also has an overlay to display the list on your stream.
 
@@ -149,28 +151,48 @@ You need to create a button on your Owncast page, so your viewers can access the
     ```
 5. Configure the remaining fields/options as desired.
 
+### Donations
+Only Owncast authenticated users can get donation benefits. So the first thing viewers need to do is authenticate their username with Owncast.
+
+OwnchatBot associates viewer accounts with Ko-fi and GiveButter accounts using the viewer's email address. So in order for viewers to get donation benefits in-stream, they must enter their email address in OwnchatBot viewer panel -> OwnchatBot Info -> Donations.
+
+If a viewer donates/subscribes before entering their email address, OwnchatBot creates a temporary entry with their email and points award, 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. There are more details about this in the Manage Accounts panel
+
+Email addresses are **ONLY** used for donation 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.
+
+Ko-fi has support for anonymous donations built right in, but GiveButter doesn't yet. So as a work-around, I've put instructions for setting up GiveButter custom fields at the bottom of the Donations management panel. Keep in mind this only makes them anonymous for OwnchatBot. All details are still visible in the GiveButter dashboard.
+Ownchatbot will still send a chat alert for anonymous donations, but no identifying information is included. OwnchatBot also does not log any identifying information related anonymous donations.
+
 ### Kofi Integration
 
 #### Make sure you don't lose your viewers' benefits! It is extremely important that you back up your instance folder daily, if not hourly.
 
-Integration is accomplished via a webhook triggered by Kofi every time a donation or subscription is made. Again, this webhook is your external OwnchatBot server address with `/kofiHook` appended.
+Integration is accomplished via a webhook triggered by Ko-fi every time a donation or subscription is made. Again, this webhook is your external OwnchatBot server address with `/kofiHook` appended.
 
-Paste the webhook address into Kofi -> More -> API -> Webhooks -> Webhook URL.
+Paste the webhook address into Ko-fi -> More -> API -> Webhooks -> Webhook URL.
   ```
   https://<your_external.ownchatbot.url>/kofiHook
   ```
 
 Click "Update", but stay on this page.
 
-You need the verification token from Kofi. Kofi sends this token when it triggers the webhook.
+You need the verification token from Ko-fi. Ko-fi sends this token 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".
+A pre-generated token will already be there. Copy that token, and paste it into the OCB Management Panel -> Donations -> Kofi -> Verification Token. Then click "Save".
 
-OwnchatBot associates viewer accounts with Kofi accounts using the viewer's 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.
+### GiveButter Integration
 
-If a viewer donates/subscribes before entering their email address, OwnchatBot creates a temporary entry with their email and points award, 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.
+#### Make sure you don't lose your viewers' benefits! It is extremely important that you back up your instance folder daily, if not hourly.
+
+Integration is accomplished via a webhook triggered by Kofi every time a donation or subscription is made. This webhook is also your external OwnchatBot server address with `/gbHook` appended.
 
-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.
+Enter this in the GiveButter dashboard -> Settings -> Developers -> Webhooks -> +New Webhook.
+  ```
+  https://<your_external.ownchatbot.url>/gbHook
+  ```
+You need a signing secret from GiveButter. This is sent when it triggers the webhook.
+To get this, go to the Webhooks page in the GiveButter dashboard, and click on the eye icon (View) next to the webhook you set up for OwnchatBot.
+Copy the signing secret, and paste it into the OCB Management Panel -> Donations -> GiveButter -> Signing Secret. Then click "Save".
 
 ## Overlays
 To display vote and goal progress on-screen, in your stream, create two browser sources in your streaming software.