z-inspire
v1.0.0
Published
A CLI tool to inspire you based on how you are feeling
Downloads
12
Maintainers
Readme
z-inspire
z-inspire
is a CLI tool that provides inspirational quotes based on your mood.
Installation
To install z-inspire
globally, run the following command:
npm install -g z-inspire
Usage
Once installed, you can use the z-inspire command to get an inspirational quote:
z-inspire
Development
Prerequisites
- Node.js (version 14 or higher)
- npm (version 6 or higher)
Setup
Clone the repository:
git clone https://github.com/Zengry10/z-inspire.git cd z-inspire
Install dependencies:
npm install
Note: The node_modules directory is not included in the repository and should be installed using the above command.
Running the CLI Locally
To run the CLI tool locally without installing it globally, use:
node bin/z-inspire
Running Tests
To run tests, use:
npm test
Contribution Guide
- Fork the repository.
- Create a new branch for your feature or bugfix.
- Make your changes and commit them with descriptive messages.
- Push your changes to your fork.
- Create a pull request to the main repository.
Code of Conduct
Please adhere to the Contributor Covenant Code of Conduct when contributing to this project.
License
This project is licensed under the ISC License - see the LICENSE file for details.