From 7d4081d340c4995d9081e7ae7c682c2190aa9cc8 Mon Sep 17 00:00:00 2001
From: flameshikari <mail@hexed.pw>
Date: Thu, 29 Feb 2024 03:04:30 +0500
Subject: [PATCH] add readme

---
 .github/README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/.github/README.md b/.github/README.md
index e69de29..2d79174 100644
--- a/.github/README.md
+++ b/.github/README.md
@@ -0,0 +1,28 @@
+# Зачем?
+
+[Потому что русский — язык террористов](https://github.com/outline/outline/discussions/5706).
+
+# Примечания
+
+По возможности буду поддерживать контейнер, обновлять до текущей версии, добавлять переводы для новых пунктов (но ничего не обещаю). Перевод может быть неточным, буду рад помощи.
+
+# Установка
+
+Всё делается по [официальной инструкции](https://docs.getoutline.com/s/hosting/doc/docker-7pfeLP5a8t), только в качестве `image` нужно использовать `flameshikari/outline-ru`.
+
+```yaml
+  ...
+
+  outline:
+    image: flameshikari/outline-ru:latest
+    env_file: ./docker.env
+    ports:
+      - "3000:3000"
+    volumes:
+      - storage-data:/var/lib/outline/data
+    depends_on:
+      - postgres
+      - redis
+
+  ...
+```
\ No newline at end of file