telekit-lib 2.0.1 → 2.0.2

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.
package/README.md CHANGED
@@ -23,7 +23,8 @@ npm install telekit-lib
23
23
 
24
24
  ## 📖 Документация
25
25
 
26
- Полная документация доступна в папке [`docs/`](./docs). Откройте `docs/index.html` в вашем браузере.
26
+ Полная и красивая документация доступна онлайн:
27
+ 👉 [**https://tahel-udev.github.io/telekit/**](https://tahel-udev.github.io/telekit/)
27
28
 
28
29
  ## ⚡ Быстрый старт
29
30
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "telekit-lib",
3
- "version": "2.0.1",
3
+ "version": "2.0.2",
4
4
  "description": "Профессиональный TypeScript фреймворк для Telegram ботов со встроенной LocalDB",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
package/PUBLISHING.md DELETED
@@ -1,52 +0,0 @@
1
- # 🚀 Руководство по публикации TeleKit
2
-
3
- Это руководство объясняет, как опубликовать вашу библиотеку в NPM, на GitHub и разместить документацию.
4
-
5
- ## 1. Подготовка к NPM
6
-
7
- 1. **Войдите в NPM** (если еще не вошли):
8
- ```bash
9
- npm login
10
- ```
11
- 2. **Соберите проект**:
12
- ```bash
13
- npm run build
14
- ```
15
- *Это создаст папку `dist`, которая и будет опубликована.*
16
- 3. **Опубликуйте**:
17
- ```bash
18
- npm publish --access public
19
- ```
20
- *Убедитесь, что версия в `package.json` уникальна (например, 2.0.0).*
21
-
22
- ## 2. Отправка на GitHub
23
-
24
- 1. **Инициализируйте Git**:
25
- ```bash
26
- git init
27
- git add .
28
- git commit -m "Initial commit of TeleKit 2.0"
29
- ```
30
- 2. **Отправьте (Push)**:
31
- ```bash
32
- git remote add origin https://github.com/TaHel-UDev/telekit.git
33
- git branch -M main
34
- git push -u origin main
35
- ```
36
-
37
- ## 3. Хостинг документации (Landing Page)
38
-
39
- У вас есть красивая документация в стиле "Shadcn" в папке `docs/`.
40
-
41
- **Вариант А: GitHub Pages (Самый простой)**
42
- 1. Перейдите в настройки репозитория (Repository Settings) > Pages.
43
- 2. Выберите источник: **Deploy from branch**.
44
- 3. Ветка: `main`, Папка: `/docs`.
45
- 4. Нажмите **Save**. Ваш сайт будет доступен по адресу `https://tahel-udev.github.io/telekit/` через несколько минут.
46
-
47
- **Вариант Б: Netlify / Vercel**
48
- 1. Перетащите папку `docs` в Netlify Drop.
49
- 2. Мгновенное развертывание.
50
-
51
- ---
52
- *Автор TaHel-UDev*
package/PUBLISH_GUIDE.md DELETED
@@ -1,52 +0,0 @@
1
- # Инструкция по публикации библиотеки в NPM
2
-
3
- Чтобы вашей библиотекой могли пользоваться другие люди (устанавливать через `npm install easy-tg-bot-lib`), её нужно опубликовать в реестре NPM.
4
-
5
- ## Шаг 1: Подготовка
6
- 1. Убедитесь, что код скомпилирован:
7
- ```bash
8
- npm run build
9
- ```
10
- 2. Убедитесь, что в `package.json` поле `main` указывает на `dist/index.js`, а `types` на `dist/index.d.ts`. Это уже настроено.
11
- 3. (Опционально) Создайте файл `.npmignore`, чтобы не отправлять в NPM лишние файлы (исходники, конфиги), оставив только папку `dist` и `package.json`.
12
- Содержимое `.npmignore`:
13
- ```
14
- src/
15
- tsconfig.json
16
- examples/
17
- ```
18
-
19
- ## Шаг 2: Регистрация в NPM
20
- Если у вас еще нет аккаунта:
21
- 1. Перейдите на [npmjs.com](https://www.npmjs.com/) и зарегистрируйтесь.
22
- 2. В терминале выполните вход:
23
- ```bash
24
- npm login
25
- ```
26
- Следуйте инструкциям (ввод username, password, email).
27
-
28
- ## Шаг 3: Публикация
29
- 1. **Важно**: Имя пакета в `package.json` (`"name": "easy-tg-bot-lib"`) должно быть уникальным во всем NPM. Скорее всего, простые имена уже заняты.
30
- - Рекомендуется использовать scope (пространство имен), например `@ваш-ник/easy-bot`.
31
- - Для этого измените имя в `package.json` на `@ваш-ник/easy-bot`.
32
- 2. Выполните команду:
33
- ```bash
34
- npm publish --access public
35
- ```
36
- (Флаг `--access public` обязателен для scoped-пакетов, так как по умолчанию они считаются приватными и требуют платной подписки).
37
-
38
- ## Шаг 4: Обновление версий
39
- Когда вы внесете изменения в код:
40
- 1. Измените версию в `package.json` (например, с `1.0.0` на `1.0.1`).
41
- 2. Снова выполните `npm run build`.
42
- 3. Снова выполните `npm publish`.
43
-
44
- ## Как будут устанавливать вашу библиотеку
45
- Пользователи будут писать:
46
- ```bash
47
- npm install @ваш-ник/easy-bot
48
- ```
49
- И использовать:
50
- ```typescript
51
- import { EasyBot } from '@ваш-ник/easy-bot';
52
- ```