From bd96baa61f47047351cb9c299cf7056808349b0d Mon Sep 17 00:00:00 2001 From: Ole Morud <82065181+olemorud@users.noreply.github.com> Date: Tue, 16 May 2023 15:50:59 +0200 Subject: [PATCH] [skip ci] Update README.md --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 190f0ef..84d8dca 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ # Mattermost Coffee Bot +Pings a set of people when someone writes a message starting with a keyword. + +![image](https://github.com/olemorud/mattermost-coffee-ping/assets/82065181/244fcc06-2c9c-4e5e-961a-d92a2f253178) + + ## Setup These instructions have not been thoroughly tested, open an issue if something @@ -10,14 +15,15 @@ does not work or is unclear. Open the Channel you want the bot integration for in Mattermost. -On the top-left there is a waffle menu icon: (looks kind of like: ☷) +On the top-left there is a waffle menu icon: ![image](https://github.com/olemorud/mattermost-coffee-ping/assets/82065181/3ebe3023-9bac-4c4b-801a-209c37633cfe) -Open **☷ -> Integrations -> Outgoing Webhooks -> Add Outgoing Webhook** +Open **![image](https://github.com/olemorud/mattermost-coffee-ping/assets/82065181/7ba5a126-e138-472d-8820-9a77e2b63f7e) -> Integrations -> Outgoing Webhooks -> Add Outgoing Webhook** Add required and optional fields as you wish, but leave the Callback URLs field empty for now. When saved, a card with information containing a _Token_ should be displayed. This will be used later. + ### Setting up Google Cloud #### Setting up the project @@ -57,6 +63,7 @@ Open **Google Cloud -> Security -> Secret Manager** ([link](https://console.clou with appropriate values. + ### GitHub repository setup #### Adding secrets @@ -76,6 +83,7 @@ add the following repository secrets: Open **Actions -> Deploy Google Cloud Function** and press **Run workflow**. Deploying a function usually takes a around 5 minutes. + ### Verify and final fixes Open **Google Cloud -> Cloud Functions** [link](https://console.cloud.google.com/functions/list)