feat: solution for 'Экзамен: Самокорректирующийся агент'

README.md

@@ -1,37 +1,69 @@
-# Graph Reflexivity Project
+# Самокорректирующийся агент
 
-This project demonstrates a simple graph implementation in JavaScript that supports reflexivity (adding self-loops to all nodes). It uses the `graphlib` library for graph data structures and `lodash` for utility functions.
+## Описание
 
-## Installation
+Данный проект реализует простого **самокорректирующегося агента** на Node.js. Агент генерирует ответ на заданный вопрос, а затем использует API OpenAI для проверки и улучшения своего ответа. Это демонстрационный пример того, как можно интегрировать модель GPT в цикл самокоррекции.
+
+## Требования
+
+- Node.js версии 18+ (рекомендуется LTS)
+- npm (или yarn)
+- **Пакеты, необходимые для работы проекта:**
+  - `dotenv` – для загрузки переменных окружения из файла `.env`
+  - `openai` – официальный клиент OpenAI для взаимодействия с API
+  - `jest` – для запуска тестов (только в режиме разработки)
+
+## Установка
 
 ```bash
+# Клонируйте репозиторий
+git clone https://git.brojs.ru/kuzakhmetovartur/ekzamen-samokorrektiruyuschiysya-agent.git
+cd ekzamen-samokorrektiruyuschiysya-agent
+
+# Установите зависимости
 npm install
 ```
 
-## Running the Example
+## Конфигурация
 
-```bash
-node src/index.js
+Создайте файл `.env` в корне проекта и добавьте ваш ключ API OpenAI:
+
+```dotenv
+OPENAI_API_KEY=sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 ```
 
-You will see the adjacency list before and after applying reflexivity.
+> ⚠️ **Важно**: Никогда не публикуйте ваш ключ API в публичных репозиториях.
 
-## Testing
+## Использование
 
-Run the test suite with:
+Запустите скрипт:
+
+```bash
+npm start
+```
+
+Пример вывода:
+
+```
+Вопрос: Какой язык программирования лучше всего подходит для веб-разработки?
+Ответ: JavaScript является популярным выбором для веб-разработки благодаря своей гибкости и широкому сообществу.
+Самокоррекция: После проверки, ответ можно уточнить: JavaScript, особенно в сочетании с фреймворками вроде React или Vue, обеспечивает быстрый и интерактивный пользовательский интерфейс.
+```
+
+## Тесты
+
+Для запуска тестов используйте:
 
 ```bash
 npm test
 ```
 
-The tests cover basic graph operations, reflexivity, and adjacency list generation.
+Тесты находятся в папке `__tests__` и проверяют базовую работу агента.
 
-## Dependencies
+## Лицензия
 
-- **graphlib** – Provides the underlying graph data structure.
-- **lodash** – Utility library (used for potential future extensions).
-- **jest** – Testing framework (dev dependency).
+MIT © 2026
 
-## License
+---
 
-MIT
+> **Примечание**: Этот проект создан в рамках экзамена по теме «Самокорректирующийся агент» и служит демонстрацией базовой реализации. Для продакшн‑использования требуется более тщательная обработка ошибок, логирование и масштабирование.