# Документация Image Processor Library

Добро пожаловать в документацию библиотеки `image-processor-lib`! Здесь вы найдете все необходимые материалы для эффективного использования библиотеки.

## 📚 Структура документации

### Основные документы

- **[Руководство по использованию](./USAGE_GUIDE.md)** - Полное руководство с примерами кода
- **[API Reference](./API_REFERENCE.md)** - Документация всех интерфейсов и методов

### Примеры использования

- **[Базовые примеры](./examples/basic-usage.ts)** - Простые примеры для быстрого старта
- **[Продвинутые примеры](./examples/advanced-usage.ts)** - Сложные сценарии и оптимизация
- **[Примеры интеграции](./examples/integration-examples.ts)** - Интеграция с различными фреймворками

## 🚀 Быстрый старт

1. **Начните с [Руководства по использованию](./USAGE_GUIDE.md)** для базовой настройки
2. **Изучите [API Reference](./API_REFERENCE.md)** для понимания всех возможностей
3. **Просмотрите примеры** в директории `examples/` для практического применения

## 📖 Что вы найдете в документации

### В Руководстве по использованию:
- 🏗️ Настройка модуля за 5 минут
- ⚙️ Гибкая конфигурация размеров и форматов
- 📱 DPR поддержка для Retina дисплеев
- 🔧 Storage Drivers (локальное, AWS S3, Cloudinary)
- 🛠️ Интеграция с NestJS, GraphQL, Bull Queue
- 🎯 Лучшие практики и оптимизация
- ❌ Обработка ошибок

### В API Reference:
- 📋 Полная документация всех интерфейсов
- 🔧 Описание классов и методов
- 📝 Примеры использования каждого компонента
- ⚠️ Классы ошибок и их обработка
- 📊 Поддерживаемые форматы и ограничения

### В примерах:
- 🎮 Готовые контроллеры и сервисы
- ☁️ Интеграция с облачными сервисами
- 📊 Анализ и оптимизация изображений
- 💾 Кэширование и метаданные
- 🔄 Массовая обработка изображений

## 🎯 Основные возможности библиотеки

- ✅ **Современные форматы** - WebP, AVIF поддержка
- ✅ **DPR поддержка** - Retina дисплеи (1x, 2x, 3x)
- ✅ **Адаптивные размеры** - Автоматическая генерация srcset
- ✅ **Гибкая конфигурация** - Размеры, форматы, качество
- ✅ **Storage абстракция** - Любые драйверы хранилища
- ✅ **TypeScript** - Полная типизация
- ✅ **Валидация** - Проверка файлов и изображений
- ✅ **Обработка ошибок** - Специализированные классы

## 📞 Поддержка

Если у вас есть вопросы или предложения:

1. Ознакомьтесь с документацией
2. Изучите примеры в директории `examples/`
3. Проверьте тесты в проекте
4. Создайте issue в репозитории

---

**Начните с [Руководства по использованию](./USAGE_GUIDE.md) для быстрого старта!** 🚀