Added npx usage example in the README

This commit is contained in:
Renato 2022-05-17 10:14:22 +10:00 committed by GitHub
parent 6c1798f8c8
commit 5a6bb397b1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions

View File

@ -527,5 +527,10 @@ After installing gamedig globally, you can call gamedig via the command line:
gamedig --type minecraft mc.example.com:11234
```
Alternatively, if you don't want to install gamedig globally, you can run it with npx:
```shell
npx gamedig --type minecraft mc.example.com:11234
```
The output of the command will be in JSON format. Additional advanced parameters can be passed in
as well: `--debug`, `--pretty`, `--socketTimeout 5000`, `--requestRules` etc.