Update README.md

This commit is contained in:
Sharon 2020-05-06 20:43:20 -04:00 committed by GitHub
parent 19217eb4d3
commit f837264d76
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,9 +1,8 @@
# OCRCC Bot
# Safe Support Chat Bot
A simple Matrix bot that handles inviting, uninviting, and notifying Riot users on the recieving end of the [OCRCC chatbox](https://github.com/nomadic-labs/ocrcc-chatbox).
A simple Matrix bot that handles inviting, uninviting, and notifying Riot users on the recieving end of the [Safe Support chatbox](https://github.com/nomadic-labs/safesupport-chatbox).
A demo of this bot is hosted on Glitch: https://glitch.com/edit/#!/nomadic-labs-ocrcc-bot
You can remix it and continue developing directly on Glitch. All you need to do is add an `.env` file with the following variables:
The bot can be configured with an `.env` file with the following variables:
```
MATRIX_SERVER_URL=
@ -41,12 +40,12 @@ If you prefer to develop locally instead of on Glitch:
Clone the project
```
git clone https://github.com/nomadic-labs/ocrcc-bot.git
git clone https://github.com/nomadic-labs/safesupport-bot.git
```
Install dependencies
```
cd ocrcc-bot
cd safesupport-bot
yarn
```