README.md

A command-line interface that enables the users to see CoVID-19 statistics on their terminal or command prompt. It provides the flexibility to check global CoVID-19 statistics as well as statistics of a particular country or nation.

Table of Contents

1. Installation
2. Usage
3. Contributing
4. License

Installation

The CoVID-19 CLI is available for free on NPM.

npm install -g covid-19

The CoVID-19 CLI can also be installed using the source code on GitHub. Kindly follow the steps given below.

1. Clone or download the repository

   git clone https://github.com/dmahajan980/covid19.git

2. Install all the dependencies

   npm install

3. Add a symbolic link to the global folder

   • Windows
     Open cmd.exe as Administrator and run the following command inside the root of the project directory

     npm link

   • macOS/Linux
     Open the terminal and run the following command inside the root of the project directory

     sudo npm link

Usage

This CLI is very easy to use.

covid19

This is the name of the package that is used to invoke the CLI.
The following flag is supported.

Flag	Alias	Description
--version	-v	Display the current version of the program

Example:

covid19 -v

covid19 --version

covid19 stats

This command returns the statistics of CoVID-19 all over the world.

Example:

covid19 stats

The following flag is supported.

Flag	Alias	Description
--country <countryName>	-c <countryName>	Display statistics for a particular country

The supported formats for countryName are ISO2, ISO3 or a single-word name. A list of ISO Country Codes can be found here.

Example:

covid19 stats -c India

covid19 stats --country India

Contributing

Kindly go through the list of active issues or open a new issue to discuss potential changes/additions.

License

This project is licensed under the MIT License - see the LICENSE file for details.