davtur19
/
tgscraper
mirror of https://github.com/Sysbot-org/tgscraper.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated README

This commit is contained in:
Sys 2021-07-24 19:07:33 +02:00
parent ce4836623b
commit 3f7fe4cfb9
No known key found for this signature in database
GPG Key ID: 3CD2C29F8AB39BFD
1 changed files with 36 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -22,8 +22,42 @@ Install the library with composer:
## Using from command line
Once installed, you can use the CLI to interact with the library:
Once installed, you can use the CLI to interact with the library.
For basic help and command list:
```bash
$ vendor/bin/tgscraper
$ vendor/bin/tgscraper help
```
### JSON
Extract the latest schema in a human-readable JSON:
```bash
$ vendor/bin/tgscraper app:export-schema --readable botapi.json
```
Or, if you want a Postman-compatible JSON (thanks to [davtur19](https://github.com/davtur19/TuriBotGen/blob/master/postman.php)):
```bash
$ vendor/bin/tgscraper app:export-schema --postman botapi_postman.json
```
### YAML
Extract the latest schema in YAML format:
```bash
$ vendor/bin/tgscraper app:export-schema --yaml botapi.yaml
```
### Stubs
TGScraper can also generate class stubs that you can use in your library. A sample implementation is available in the [Sysbot API module](https://github.com/Sysbot-org/Sysbot-api).
Create stubs in the `out/` directory using `Sysbot\Api` as namespace prefix:
```bash
$ vendor/bin/tgscraper app:create-stubs --namespace-prefix "Sysbot\Api" out
```