Подготовка к релизу v1.3.1

1 files changed, 22 insertions, 17 deletions

diff --git a/README.md b/README.md
index 9e30da0..ba6e4b3 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,14 @@
+<img src="https://git.macaw.me/skunky/SkunkyArt/raw/branch/master/misc/logo.png" alt="SkunkyArt" title="SkunkyArt Logo" width="20%"/>
+
 [![Matrix room](https://img.shields.io/badge/matrix-000000?style=for-the-badge&logo=Matrix&logoColor=white)](https://go.kde.org/matrix/#/#skunkyart:ebloid.ru)
 # Instances
-|Инстанс|Yggdrasil|I2P|Tor|NSFW|Proxifying|Country|
-|:-----:|:-------:|:-:|:-:|:--:|:--------:|:-----:|
+|Instance|Yggdrasil|I2P|Tor|NSFW|Proxifying|Country|
+|:------:|:-------:|:-:|:-:|:--:|:--------:|:-----:|
 |[skunky.ebloid.ru](https://skunky.ebloid.ru/art)|[Yes](http://[201:eba5:d1fc:bf7b:cfcb:a811:4b8b:7ea3]/art)|No|No| No | No | Russia |
 |[clovius.club](https://skunky.clovius.club)|No|No|No| Yes | Yes | Sweden |
 |[bloat.cat](https://skunky.bloat.cat)|No|No|No| Yes | Yes | Romania |
 |[frontendfriendly.xyz](https://skunkyart.frontendfriendly.xyz)|No|No|No| Yes | Yes | Finland |
+|[lumaeris.com](https://skunkyart.lumaeris.com)|No|No|No| Yes | Yes | US |
 
 # EN 🇺🇸
 ## Description
@@ -13,12 +16,12 @@ SkunkyArt 🦨 -- alternative frontend to DeviantArt, which will work without pr
 ## Config
 The sample config is in the `config.example.json` file. To specify your own path to the config, use the CLI argument `-c` or `--config`.
 * `listen` -- the address and port on which SkunkyArt will listen
-* `base-path` -- the path to the instance. Example: "`base-path`:"/art/" -> https://skunky.ebloid.ru/art/
+* `base-path` -- the path to the instance. Example: `"base-path":"/art/"` -> https://skunky.ebloid.ru/art/
 * `cache` -- caching system; default is off.
-* * `path` -- the path to the cache
-* * `lifetime` -- cache file lifetime; measured in Unix milliseconds.
-* * `max-size` -- maximum file size in bytes.
-* `dirs-to-memory` -- this setting determines which directories will be copied to RAM when SkunkyArt is started. Required
+  * `path` -- the path to the cache
+  * `lifetime` -- the lifetime of the file in the cache. Units: i, h, d, w, m, y. I -- minute, all other units I think are self-explanatory.
+  * `max-size` -- maximum file size in megabytes.
+* `dirs-to-memory` -- this setting determines which directories will be copied to RAM when SkunkyArt is started. Mandatory
 * `download-proxy` -- proxy address for downloading files.
 ## Examples of reverse proxies
 Nginx:
@@ -27,17 +30,18 @@ server {
     listen 443 ssl;
     server_name skunky.example.com;
     
-    location ((BASE URL)) { # if you have a separate subdomain for the frontend, insert '/' instead of '((BASE URL))'.
-        proxy_set_header Scheme $scheme;
+    location ((BASE URL)) { # if you have a separate subdomain for the frontend, insert '/' instead of '((BASE URL)))'.
+        proxy_set_header X-Forwarded-Proto $scheme;
         proxy_set_header Host $host;
         proxy_http_version 1.1;
         proxy_pass http://((IP)):((PORT));
     }
 }
 ```
+Pretty much business as usual, except for the [`X-Forwarded-Proto`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Proto) header setting.
 ## How do I add my instance to the list?
-To do this, you must either make a PR by adding your instance to the `instances.json` file, or report it to the room in Matrix. I don't think it needs any description. However, be aware, this list has a couple rules:
-1. the instance must not use Cloudflare.
+To do this, you must either make a PR by adding your instance to the `instances.json` and `README.md` files, or create an Issue, or report it to the room in Matrix. I don't think it needs any description. However, be warned, this list has a couple rules:
+1. the Instance must not use Cloudflare.
 2. If your instance has modified source code, you need to publish it to any free platform. For example, Github and Gitlab are not.
 ## Acknowledgements
 * [Лис⚛](https://go.kde.org/matrix/#/@fox:matrix.org) -- helped me understand Go and gave me a lot of useful advice on this language.
@@ -48,11 +52,11 @@ SkunkyArt 🦨 -- альтернативный фронтенд к DeviantArt, �
 ## Конфиг
 Пример конфига находится в файле `config.example.json`. Чтобы указать свой путь до конфига, используйте CLI-аргумент `-c` или `--config`.
 * `listen` -- адрес и порт, на котором будет слушать SkunkyArt
-* `base-path` -- путь к инстансу. Пример: "base-path": "/art/" -> https://skunky.ebloid.ru/art/
+* `base-path` -- путь к инстансу. Пример: `"base-path": "/art/"` -> https://skunky.ebloid.ru/art/
 * `cache` -- система кеширования; по умолчанию - выкл.
-* * `path` -- путь до кеша
-* * `lifetime` -- время жизни файла в кеше; измеряется в Unix-миллисекундах
-* * `max-size` -- максимальный размер файла в байтах
+  * `path` -- путь до кеша
+  * `lifetime` -- время жизни файла в кеше. Единицы измерения: i, h, d, w, m, y. I -- минута, всё остальные единицы измерения, я считаю понятными и без объяснения.
+  * `max-size` -- максимальный размер файла в мегабайтах
 * `dirs-to-memory` -- данная настройка определяет какие каталоги будут скопированы в ОЗУ при запуске SkunkyArt. Обязательна
 * `download-proxy` -- адрес прокси для загрузки файлов
 ## Примеры reverse-прокси
@@ -63,15 +67,16 @@ server {
     server_name skunky.example.com;
     
     location ((BASE URL)) { # если у вас отдельный поддомен для фронтенда, вместо '((BASE URL))' вставляйте '/'
-        proxy_set_header Scheme $scheme;
+        proxy_set_header X-Forwarded-Proto $scheme;
         proxy_set_header Host $host;
         proxy_http_version 1.1;
         proxy_pass http://((IP)):((PORT));
     }
 }
 ```
+В целом, всё как обычно, за исключением настройки заголовка [`X-Forwarded-Proto`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Proto).
 ## Как добавить свой инстанс в список?
-Чтобы это сделать, вы должны либо сделать PR, добавив в файл `instances.json` свой инстанс, либо сообщить о нём в комнате в Matrix. Думаю, он не нуждается в описании. Однако учтите, у этого списка есть пара правил:
+Чтобы это сделать, вы должны либо сделать PR, добавив в файлы `instances.json` и `README.md` свой инстанс, либо создать Issue, или сообщить о нём в комнате в Matrix. Думаю, он не нуждается в описании. Однако учтите, у этого списка есть пара правил:
 1. Инстанс не должен использовать Cloudflare.
 2. Если ваш инстанс имеет модифицированный исходный код, то вам нужно опубликовать его на любую свободную площадку. Например, Github и Gitlab таковыми не являются.
 ## Благодарности