diff --git a/README.md b/README.md index 55922e4..105a1d2 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,21 @@ -## Квотер +# Квотер Управляет квотами на загрузку файлов и их размещением в S3-хранилище. Поддерживает создание миниатюр для изображений и управляет квотами на использование дискового пространства для каждого пользователя с использованием Redis. -### ENV +## ENV - `REDIS_URL`: URL для подключения к Redis. Используется для управления квотами и хранения информации о загружаемых файлах. - `S3_BUCKET`: Имя S3 bucket, используемого для хранения загруженных файлов. - `CDN_DOMAIN`: Домен CDN для генерации публичных URL-адресов загруженных файлов. + +## Основные функции + + - Миниатюры: Автоматическое создание миниатюр для изображений. + - S3/STORJ интеграция: Загрузка файлов в через `aws-sdk-s3` и возврат публичных URL-адресов. + - Управление квотами: Ограничение объема загружаемых данных для каждого пользователя с использованием Redis. + - Отслеживание файлов: Хранение информации о загруженных файлах в Redis для управления квотами. + ### Как это работает 1. **Аутентификация**: @@ -31,9 +39,3 @@ 7. **Сохранение информации о загруженных файлах в Redis**: - Имя каждого загруженного файла сохраняется в Redis для отслеживания загруженных пользователем файлов. Это позволяет учитывать квоты и управлять пространством, занимаемым файлами. -### Основные функции - - - Миниатюры: Автоматическое создание миниатюр для изображений. - - S3/STORJ интеграция: Загрузка файлов в через `aws-sdk-s3` и возврат публичных URL-адресов. - - Управление квотами: Ограничение объема загружаемых данных для каждого пользователя с использованием Redis. - - Отслеживание файлов: Хранение информации о загруженных файлах в Redis для управления квотами.