[skip ci] Update README.md
This commit is contained in:
12
README.md
12
README.md
@@ -1,6 +1,11 @@
|
||||
|
||||
# Mattermost Coffee Bot
|
||||
|
||||
Pings a set of people when someone writes a message starting with a keyword.
|
||||
|
||||

|
||||
|
||||
|
||||
## 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: 
|
||||
|
||||
Open **☷ -> Integrations -> Outgoing Webhooks -> Add Outgoing Webhook**
|
||||
Open ** -> 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)
|
||||
|
||||
Reference in New Issue
Block a user