Skip to content

Commit 4e640cc

Browse files
committed
📚 Добавлена подробная инструкция по настройке
- Создан файл SETUP.md с пошаговой инструкцией - Обновлен README.md с предупреждением о необходимости настройки - Добавлены ссылки на расширение EditThisCookie - Подробное описание процесса получения cookies - Добавлены решения частых проблем - Обновлен package.json для включения SETUP.md в пакет
1 parent eab0991 commit 4e640cc

3 files changed

Lines changed: 152 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,24 @@
99

1010
Создавайте структурированные API с валидацией JSON схем, готовыми шаблонами и полной кастомизацией для ваших проектов.
1111

12+
## 🚀 **ВАЖНО: Настройка перед использованием**
13+
14+
Перед началом работы необходимо настроить аутентификацию в K2Think.ai:
15+
16+
### 📋 Краткая инструкция (5 минут):
17+
18+
1. **Регистрация**: Зайдите на https://www.k2think.ai/ и авторизуйтесь
19+
2. **Расширение**: Установите [EditThisCookie (V3)](https://chromewebstore.google.com/detail/editthiscookie-v3/ojfebgpkimhlhcblbalbfjblapadhbol)
20+
3. **Cookies**: На сайте k2think.ai нажмите на иконку расширения → Export → сохраните как `Cookie.json`
21+
4. **Конвертация**: Запустите `npm run cookies` для конвертации cookies
22+
5. **Настройка**: Выполните `source set-cookies.sh` для настройки окружения
23+
24+
### 🔗 **Подробная инструкция**: [SETUP.md](./SETUP.md)
25+
26+
> **⚠️ Важно**: Без правильной настройки cookies библиотека не будет работать!
27+
28+
---
29+
1230
## ✨ Возможности
1331

1432
- 🎯 **Готовые шаблоны** - 6 предустановленных JSON API для常见 задач
@@ -26,6 +44,8 @@
2644
npm install k2think-api-builder
2745
```
2846

47+
> **⚠️ После установки**: Обязательно выполните [настройку аутентификации](./SETUP.md) перед использованием!
48+
2949
## 🚀 Быстрый старт
3050

3151
### Базовое использование

‎SETUP.md‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# 🚀 Быстрый старт / Настройка
2+
3+
## 📋 Что нужно сделать перед использованием
4+
5+
### Шаг 1: Регистрация на K2Think.ai
6+
7+
1. Перейдите на сайт: https://www.k2think.ai/
8+
2. Зарегистрируйтесь или войдите в свой аккаунт
9+
3. Убедитесь, что вы можете использовать чат (попробуйте задать вопрос)
10+
11+
### Шаг 2: Установка расширения для браузера
12+
13+
Установите расширение **EditThisCookie (V3)** для вашего браузера:
14+
15+
- **Chrome**: https://chromewebstore.google.com/detail/editthiscookie-v3/ojfebgpkimhlhcblbalbfjblapadhbol
16+
- **Firefox**: https://addons.mozilla.org/en-US/firefox/addon/edit-this-cookie/
17+
- **Edge**: https://microsoftedge.microsoft.com/addons/detail/edit-this-cookie/fngmhnnpilhplaeedifhccceomclgfbg
18+
19+
### Шаг 3: Получение cookies
20+
21+
1. Зайдите на https://www.k2think.ai/ и авторизуйтесь
22+
2. Нажмите на иконку расширения **EditThisCookie** в браузере
23+
3. Нажмите кнопку **Export** (Экспорт)
24+
4. Сохраните файл как `Cookie.json` в корне проекта
25+
26+
### Шаг 4: Конвертация cookies
27+
28+
1. Откройте терминал в папке проекта
29+
2. Запустите конвертер:
30+
31+
```bash
32+
npm run cookies
33+
```
34+
35+
Или напрямую:
36+
```bash
37+
node src/cookie-converter.js
38+
```
39+
40+
3. Конвертер автоматически:
41+
- Прочитает `Cookie.json`
42+
- Создаст `cookies.txt`
43+
- Сгенерирует скрипт `set-cookies.sh`
44+
45+
### Шаг 5: Настройка окружения
46+
47+
Выполните сгенерированный скрипт:
48+
49+
```bash
50+
source set-cookies.sh
51+
```
52+
53+
Или установите переменную окружения вручную:
54+
```bash
55+
export K2THINK_COOKIES="ваши_сконвертированные_cookies"
56+
```
57+
58+
### Шаг 6: Проверка работы
59+
60+
Теперь библиотека готова к использованию!
61+
62+
```bash
63+
# Проверка базового функционала
64+
npm run demo
65+
66+
# Проверка диалога
67+
npm run dialog
68+
69+
# Запуск тестов
70+
npm test
71+
```
72+
73+
## 🔧 Альтернативные способы
74+
75+
### Способ 1: Через переменную окружения
76+
77+
Если у вас уже есть cookies в формате строки:
78+
```bash
79+
export K2THINK_COOKIES="token=ваш_токен; session_id=ваша_сессия"
80+
```
81+
82+
### Способ 2: Через файл cookies.txt
83+
84+
Создайте файл `cookies.txt` с содержимым:
85+
```
86+
token=ваш_токен
87+
session_id=ваша_сессия
88+
```
89+
90+
Библиотека автоматически прочитает этот файл.
91+
92+
## ⚠️ Важные замечания
93+
94+
- **Безопасность**: Никогда не делитесь своими cookies!
95+
- **Срок действия**: Cookies могут истекать, при ошибках аутентификации обновите их
96+
- **Приватность**: Файлы с cookies добавлены в `.gitignore` и не попадут в репозиторий
97+
98+
## 🐛 Частые проблемы
99+
100+
### Ошибка "Cookies не найдены"
101+
- Убедитесь, что вы выполнили `source set-cookies.sh`
102+
- Проверьте, что переменная `K2THINK_COOKIES` установлена: `echo $K2THINK_COOKIES`
103+
104+
### Ошибка "Аутентификация не удалась"
105+
- Обновите cookies: повторите шаги 2-4
106+
- Убедитесь, что вы авторизованы на k2think.ai
107+
108+
### Ошибка "Файл Cookie.json не найден"
109+
- Убедитесь, что файл `Cookie.json` находится в корне проекта
110+
- Проверьте расширение файла (должно быть `.json`, не `.txt`)
111+
112+
## 🎯 Готово!
113+
114+
После выполнения этих шагов вы можете использовать все возможности библиотеки:
115+
116+
```javascript
117+
const { create } = require('k2think-api-builder');
118+
119+
// Создание API билдера
120+
const builder = await create();
121+
122+
// Использование готовых шаблонов
123+
const analyzer = builder.createFromTemplate('textAnalyzer');
124+
const result = await analyzer.execute('Отличный продукт!');
125+
console.log(result);
126+
```
127+
128+
---
129+
130+
**🎉 Поздравляем! Вы готовы использовать k2think-api-builder!**

‎package.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@
9090
"src/",
9191
"README.md",
9292
"LICENSE",
93-
"CHANGELOG.md"
93+
"CHANGELOG.md",
94+
"SETUP.md"
9495
]
9596
}

0 commit comments

Comments
 (0)