diff --git a/README.md b/README.md index 2e78953..2c7956a 100644 --- a/README.md +++ b/README.md @@ -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 ``` \ No newline at end of file