@syedahoorainali/countdown-timer v1.0.0

Countdown Timer CLI

A simple countdown timer CLI application built with Node.js, Inquirer, Chalk, and Ora.

Features

• Select hours, minutes, and seconds using a search list prompt.
• Visual countdown timer with a dynamic spinner.
• Clear and colorful output using Chalk and Ora.

Installation

To install the package, you can use npm:

npm install -g @syedahoorainali/countdown-timer

Usage

To start the countdown timer, simply run the following command in your terminal:

countdown-timer

Or try without installing

npx @syedahoorainali/countdown-timer

You will be prompted to select hours, minutes, and seconds for the countdown.

Example

$ countdown-timer
? Select Hours: 02
? Select Minutes: 30
? Select Seconds: 45

Starting timer...
Time Left: 02:30:44
Time Left: 02:30:43
...
Time Left: 00:00:01
Time Left: 00:00:00

Development

Prerequisites

• Node.js
• npm

Setup

1. Clone the repository:

git clone https://github.com/yourusername/cli-countdown-timer.git
cd cli-countdown-timer

2. Install dependencies:

npm install

Building the Package

To build the package for distribution:

npm run build

Running the CLI Locally

To run the CLI locally for development purposes:

npm start

Contributing

Contributions are welcome! Please feel free to submit a Pull Request or open an issue on GitHub.

Acknowledgements

• Inquirer - A collection of common interactive command line user interfaces.
• Chalk - Terminal string styling done right.
• Ora - Elegant terminal spinner.
• inquirer-search-list - Inquirer prompt for search list.

Author

• Syeda Hoorain ali

Make sure to replace the placeholders with your actual details:
- `yourusername` with your GitHub username.
- `Your Name` with your name.

This `README.md` provides an overview of the package, installation instructions, usage examples, development setup, contribution guidelines, and acknowledgements. It should be a good starting point for your npm package documentation.