Notes-CLI

Notes-CLI is a simple command-line note-taking application that allows you to create and save notes instantly using simple commands.

Prerequisites

Before you run this project, make sure you have the following installed:

• Node.js (version 18 or higher)
• npm (Node Package Manager)

Getting Started

1. Clone the Repository

Clone this repository to your local machine using the following command:

git clone https://github.com/isandeepdev/notes-cli.git

2. Install Dependencies

Navigate to the project directory and install the required dependencies:

cd notes-cli
npm install

3. Link the Application Globally

This will create a symbolic link between your project and the global npm modules directory, making the note command available globally.

npm link

4. Run the Application

After linking, you can run the application by simply using the note command in any terminal:

note "Your note content"

Contributing

1. Fork the repository.
2. Create your branch (git checkout -b feature-branch).
3. Commit your changes (git commit -am 'Add new feature').
4. Push to the branch (git push origin feature-branch).
5. Create a new Pull Request.

License

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

Bugs and Issues

If you encounter any issues or bugs, feel free to open an issue in the GitHub Issues section.

Author

• Author: isandeepdev
• GitHub: isandeepdev