From d671e72e7215305604820f55670aa06f6dd4d882 Mon Sep 17 00:00:00 2001
From: Sharon <sharon.peishan.kennedy@gmail.com>
Date: Mon, 2 Mar 2020 17:43:30 -0500
Subject: [PATCH] Create README.md

---
 README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..85429d1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# OCRCC 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 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:
+
+```
+MATRIX_SERVER_URL="https://matrix.org"
+BOT_DISPLAY_NAME="Example Bot"
+BOT_USERNAME="example-bot"
+BOT_PASSWORD="password"
+BOT_USERID="@example-bot:matrix.org"
+FACILITATOR_ROOM_ID="!example:matrix.org"
+CHAT_OFFLINE_MESSAGE="There is no-one currently available to chat."
+```
+
+## Local development
+If you prefer to develop locally instead of on Glitch:
+
+Clone the project
+```
+git clone https://github.com/nomadic-labs/ocrcc-bot.git
+```
+
+Install dependencies
+```
+cd ocrcc-bot
+yarn
+```
+
+Copy the sample `.env` file and add in your own variables
+```
+cp .env.sample .env
+```
+
+Start the local server
+```
+yarn start
+```
+