hyper-tuner
/
ini
mirror of https://github.com/hyper-tuner/ini.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README and usage

This commit is contained in:
Piotr Rogowski 2022-10-18 12:14:42 +02:00
parent fc70abcac4
commit 4aefc9883e
No known key found for this signature in database
GPG Key ID: 4A842D702D9C6F8F
2 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -26,8 +26,16 @@ npm i --save @hyper-tuner/ini
## CLI capabilities
You can also run this package as a CLI tool, example:
You can also run this package as a CLI tool.
First you need to provide PAT as a ENV:
```bash
npx @hyper-tuner/ini validate test/data/ini/202207.ini
export NPM_GITHUB_TOKEN=my_github_personal_access_token
```
No you can run the tool:
```bash
npx hyper-tuner/ini validate test/data/ini/202103.ini
```

2
src/cli.ts
View File

@ -14,7 +14,7 @@ const loadFile = (filename: string) => {
const showUsage = () => {
console.info('\nℹ Usage:');
console.info('hypertuner-ini validate some_ini_file.ini');
console.info('npx hyper-tuner/ini validate some_ini_file.ini');
process.exit(1);
};