Skip to content

Commit 5d60283

Browse files
committed
Update README
1 parent 15343a5 commit 5d60283

1 file changed

Lines changed: 24 additions & 5 deletions

File tree

README.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,36 @@
11
# DevKit
2-
DevKit to scrape Telegram Bot API and generate PHP entities for the xBot framework.
2+
DevKit is a specialized tool designed to facilitate updating the xBot library. Its primary purpose is to scrape the Telegram Bot API to generate and update Telegram-defined entities and methods within the xBot framework.
3+
4+
## Features
5+
6+
- Specific scraping of the Telegram Bot API for xBot.
7+
- Automatic generation and updating of PHP entities and methods defined by Telegram for the xBot framework.
8+
9+
## Prerequisites
10+
11+
- PHP 8.2 or higher.
12+
- Composer installed.
313

414
## Installation
5-
The installation of this library can be done with Composer:
15+
16+
This library can be installed with Composer:
617

718
```bash
8-
composer require mk4u/http
19+
composer require al3x5/xbot-devkit
920
```
1021

1122
## Usage
12-
This library simplifies the creation of entities for working with xBot.
23+
This library is designed exclusively for updating the xBot library. To use this tool and update entities and methods, simply type the following command in your console:
1324

14-
To use this tool, simply type the following in your console:
1525
```bash
1626
php vendor/bin/update-api
1727
```
28+
29+
> [!NOTE]
30+
> This tool is intended solely for updating the xBot library. It is not designed for use with other frameworks or libraries.
31+
32+
## License
33+
This project is licensed under the [MIT License](https://github.com/al3x5dev/xbot-devkit/blob/main/LICENSE).
34+
35+
## Contact.
36+
If you have any questions or comments, feel free to contact me via [Telegram](http://t.me/al3x5_dev).

0 commit comments

Comments
 (0)