verdnatura/grafana-find
verdnatura
/
grafana-find
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

README upgraded

This commit is contained in:
Guillermo Bonet 2022-06-21 18:11:21 +02:00
parent d1a873ba2a
commit 559de34eba
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -12,17 +12,17 @@ It's recommended to install the package globally.
```text
# npm i grafana-find
$ gafana-find <command>
$ gafana-find <string>
```
You can also install locally and use the *npx* command to execute it.
```text
$ npm install grafana-find
$ npx grafana-find <command>
$ npx grafana-find <string>
```
Create a file ".grafana-find.json" with this content:
Create a file ".grafana-find.json" with this content to don't put everytime the credentials:
```text
{
@ -31,12 +31,19 @@ Create a file ".grafana-find.json" with this content:
"password": "<pass>"
}
```
We recommend put the file into user folder ( Windows: %HOMEPATH% || Linux: $HOME )
## How to use
Execute *grafana-find* with the desired command.
```text
$ [npx] grafana-find [-u|--user <string>] [-s|--string <string>]
[-h|--help] <command> [<args>]
```
$ [npx] grafana-find [-h|--help] [-v|--version] <string>
```
## Built with
* [Git](https://git-scm.com/)
* [nodejs](https://nodejs.org/)
* [NodeGit](https://www.nodegit.org/)