From d0941fb67a728e05bdb232e61769b044b597024f Mon Sep 17 00:00:00 2001
From: Andrew Dolgov <noreply@fakecake.org>
Date: Fri, 25 Nov 2022 07:57:18 +0300
Subject: add README

---
 README.md | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index b9a5f84..2a1a54d 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,19 @@
 # Cache S3
 
-Experimental file cache backend using S3 protocol (e.g. Minio)
+File cache backend using S3 protocol (e.g. Minio)
+
+## Installation
+
+Plugin must be enabled systemwide via `TTRSS_PLUGINS`.
+
+## Configuration
+
+The following options are required:
+
+```ini
+TTRSS_CACHE_S3_ENDPOINT=http://example.com:9000
+TTRSS_CACHE_S3_BUCKET=bucket-name
+TTRSS_CACHE_S3_REGION=us-east-1
+TTRSS_CACHE_S3_ACCESS_KEY=xxx
+TTRSS_CACHE_S3_SECRET_KEY=yyy
+```
-- 
cgit v1.2.3