readme

.github/workflows/docker.yaml

@@ -23,6 +23,12 @@ jobs:
             type=semver,pattern={{version}}
             type=semver,pattern={{major}}.{{minor}}
             type=semver,pattern={{major}}
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
       # - name: Login to DockerHub
       #   uses: docker/login-action@v1
       #   with:

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>
+```

docker-compose.yaml

@@ -1,3 +1,6 @@
+# DEVELOPMENT ONLY
+# See README.md
+
 version: '3.8'
 
 services:

package.json

@@ -1,6 +1,6 @@
 {
   "private": true,
-  "version": "1.0.0-rc.0",
+  "version": "1.0.0",
   "type": "module",
   "main": "./dist/index.js",
   "engines": {