Skip to content

Commit b352868

Browse files
committed
📖 DOC: CLI Commands
1 parent 70a93c9 commit b352868

File tree

2 files changed

+22
-3
lines changed

2 files changed

+22
-3
lines changed

index.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,4 +102,10 @@ const dim = chalk.dim;
102102
});
103103
console.log(table.toString());
104104
}
105+
106+
console.log(
107+
dim(
108+
`\nFound a bug? Report here ↓\nhttps://github.com/ahmadawais/corona-cli/issues\nFollow on twitter → https://twitter.com/MrAhmadAwais\n`
109+
)
110+
);
105111
})();

readme.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@
1212
## Install
1313

1414
```sh
15-
npm install corona-cli
15+
npm install -g corona-cli
16+
17+
# OR run directly with npx.
18+
19+
npx corona-cli
1620
```
1721

1822
<br>
@@ -21,8 +25,16 @@ npm install corona-cli
2125

2226
## Usage
2327

24-
```js
25-
const coronaCli = require('corona-cli');
28+
```sh
29+
npx corona-cli # Display data for all countries.
30+
npx corona-cli --xcolor # Display data for all countries in single color.
31+
npx corona-cli -x # Display data for all countries in single color.
32+
33+
npx corona-cli country # Display data for given country.
34+
npx corona-cli china # Display data for given country i.e. China.
35+
npx corona-cli usa # Display data for given country i.e. USA.
36+
37+
npx corona-cli --help # Display data for given country.
2638
```
2739

2840
<br>
@@ -49,6 +61,7 @@ const coronaCli = require('corona-cli');
4961

5062
- MIT © [Ahmad Awais](https://twitter.com/MrAhmadAwais/)
5163
- [Code of Conduct](code-of-conduct.md)
64+
- NovelCOVID API Data from [Worldmeter](https://www.worldometers.info/coronavirus/)
5265

5366
<br>
5467

0 commit comments

Comments
 (0)