From 50650d1e07456b4b91ed71d0bc2a3fc042995276 Mon Sep 17 00:00:00 2001
From: cupcakearmy <hi@nicco.io>
Date: Mon, 20 Dec 2021 16:08:28 +0100
Subject: [PATCH] readme

---
 README.md           | 19 +++++++++++++++++++
 docker-compose.yaml |  3 +++
 package.json        |  2 +-
 3 files changed, 23 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index fd96bbe..33c0909 100644
--- a/README.md
+++ b/README.md
@@ -6,3 +6,22 @@
 [Telegraf](https://telegraf.js.org/)
 
 ## Deployment
+
+```yaml
+# docker-compose.yaml
+version: '3.8'
+
+services:
+  app:
+    image: ghcr.io/cupcakearmy/hcs
+    restart: unless-stopped
+    env_file: .env
+    volumes:
+      - ./data:/app/data
+```
+
+```bash
+# .env
+BOT_TOKEN=<telegram bot token>
+HCS_PASSWORD=<password for users>
+```
diff --git a/docker-compose.yaml b/docker-compose.yaml
index 575e462..7adfd6e 100644
--- a/docker-compose.yaml
+++ b/docker-compose.yaml
@@ -1,3 +1,6 @@
+# DEVELOPMENT ONLY
+# See README.md
+
 version: '3.8'
 
 services:
diff --git a/package.json b/package.json
index 17031db..1099064 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "private": true,
-  "version": "1.0.0-rc.1",
+  "version": "1.0.0",
   "type": "module",
   "main": "./dist/index.js",
   "engines": {