itd-sdk-js 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/API_REFERENCE.md +15 -1
  2. package/README.md +12 -4
  3. package/examples/README.md +18 -3
  4. package/examples/auto-refresh.js +1 -1
  5. package/examples/basic-usage.js +1 -1
  6. package/examples/quick-start.js +1 -1
  7. package/examples/user-friendly.js +1 -1
  8. package/package.json +1 -1
package/API_REFERENCE.md CHANGED
@@ -2,6 +2,20 @@
2
2
 
3
3
  Техническое руководство по методам и настройке библиотеки для работы с API сайта `итд.com`.
4
4
 
5
+ ## Установка
6
+
7
+ ### Через npm
8
+
9
+ ```bash
10
+ npm install itd-sdk-js
11
+ ```
12
+
13
+ ### Использование
14
+
15
+ ```javascript
16
+ import { ITDClient } from 'itd-sdk-js';
17
+ ```
18
+
5
19
  ## Настройка проекта
6
20
 
7
21
  ### 1. Переменные окружения (.env)
@@ -25,7 +39,7 @@
25
39
  JavaScript
26
40
 
27
41
  ```
28
- import { ITDClient } from './src/client.js';
42
+ import { ITDClient } from 'itd-sdk-js';
29
43
  import dotenv from 'dotenv';
30
44
 
31
45
  dotenv.config();
package/README.md CHANGED
@@ -10,16 +10,23 @@
10
10
 
11
11
  ## Установка
12
12
 
13
- Bash
13
+ ### Через npm (рекомендуется)
14
14
 
15
+ ```bash
16
+ npm install itd-sdk-js
15
17
  ```
16
- npm install
17
18
 
19
+ ### Из исходников
20
+
21
+ ```bash
22
+ git clone https://github.com/FriceKa/ITD-SDK-js.git
23
+ cd ITD-SDK-js
24
+ npm install
18
25
  ```
19
26
 
20
27
  ## Настройка
21
28
 
22
- 1. Создайте `.env` на основе `.env.example`.
29
+ 1. Создайте `.env` на основе `.env.example` (или используйте переменные окружения).
23
30
  2. Вставьте свой `ITD_ACCESS_TOKEN` (его можно вытащить из Network в DevTools).
24
31
  3. Для работы авто-обновления сессии создайте файл `.cookies` и вставьте туда строку `Cookie` из любого запроса к сайту в браузере.
25
32
 
@@ -32,8 +39,9 @@ npm install
32
39
  JavaScript
33
40
 
34
41
  ```
35
- import { ITDClient } from './src/client.js';
42
+ import { ITDClient } from 'itd-sdk-js';
36
43
  import dotenv from 'dotenv';
44
+
37
45
  dotenv.config();
38
46
 
39
47
  const client = new ITDClient();
package/examples/README.md CHANGED
@@ -58,8 +58,23 @@ node examples/auto-refresh.js
58
58
 
59
59
  ## ⚙️ Настройка перед запуском
60
60
 
61
- 1. Установите зависимости: `npm install`
62
- 2. Скопируйте `.env.example` в `.env` и заполните `ITD_ACCESS_TOKEN`
63
- 3. Создайте файл `.cookies` и вставьте туда cookies из браузера
61
+ ### Установка через npm (рекомендуется)
62
+
63
+ ```bash
64
+ npm install itd-sdk-js
65
+ ```
66
+
67
+ ### Установка из исходников
68
+
69
+ ```bash
70
+ git clone https://github.com/FriceKa/ITD-SDK-js.git
71
+ cd ITD-SDK-js
72
+ npm install
73
+ ```
74
+
75
+ ### Конфигурация
76
+
77
+ 1. Скопируйте `.env.example` в `.env` и заполните `ITD_ACCESS_TOKEN`
78
+ 2. Создайте файл `.cookies` и вставьте туда cookies из браузера
64
79
 
65
80
  Подробнее см. **[README.md](../README.md)**
package/examples/auto-refresh.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Вы просто используете API - всё работает "из коробки"!
6
6
  */
7
7
 
8
- import { ITDClient } from '../src/client.js';
8
+ import { ITDClient } from 'itd-sdk-js';
9
9
  import dotenv from 'dotenv';
10
10
 
11
11
  dotenv.config();
package/examples/basic-usage.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Показывает простоту работы с API через удобные методы.
5
5
  */
6
6
 
7
- import { ITDClient } from '../src/client.js';
7
+ import { ITDClient } from 'itd-sdk-js';
8
8
  import dotenv from 'dotenv';
9
9
 
10
10
  dotenv.config();
package/examples/quick-start.js CHANGED
@@ -11,7 +11,7 @@
11
11
  * 4. Запустите: node examples/quick-start.js
12
12
  */
13
13
 
14
- import { ITDClient } from '../src/client.js';
14
+ import { ITDClient } from 'itd-sdk-js';
15
15
  import dotenv from 'dotenv';
16
16
 
17
17
  // Загружаем переменные окружения из .env файла
package/examples/user-friendly.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Показывает, как просто работать с данными без сложных запросов.
6
6
  */
7
7
 
8
- import { ITDClient } from '../src/client.js';
8
+ import { ITDClient } from 'itd-sdk-js';
9
9
  import dotenv from 'dotenv';
10
10
 
11
11
  dotenv.config();
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "itd-sdk-js",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "Unofficial SDK for итд.com - Node.js library for working with API. Automatic token refresh, session management, and convenient methods for posts, comments, users, and notifications.",
5
5
  "main": "src/client.js",
6
6
  "type": "module",