From 217b8f5d7182c9c6c4bd585b6f843b09690c7f0d Mon Sep 17 00:00:00 2001 From: Lucas Palomo Develop Date: Thu, 29 Jun 2023 17:30:08 +0200 Subject: [PATCH] Update README.md --- README.md | 45 ++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 44 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b740513..9ccb48c 100644 --- a/README.md +++ b/README.md @@ -1 +1,44 @@ -# quicknote \ No newline at end of file +# QuickNote + +QuickNote is a simple CLI tool for creating and managing quick notes and to-do lists via the command line. + +## Compilation + +1. Clone or download the QuickNote repository. + +2. Make sure you have a C++ compiler installed on your system. + +3. Navigate to the QuickNote directory. + +4. Compile the source code: + +`$ g++ quicknote.cpp -o quicknote` + + +## Usage + +Use the following commands to create and manage notes: + +- `./quicknote add "Note content"`: Creates a new note with the specified content. + +- `./quicknote list`: Displays a list of all existing notes. + +- `./quicknote view `: Displays the content of a specific note based on its ID. + +- `./quicknote edit "New content"`: Updates the content of a specific note. + +- `./quicknote delete `: Deletes a specific note based on its ID. + +- `./quicknote search "Search term"`: Searches all notes for the specified search term and displays matches. + +## Contributing + +If you find any issues, have suggestions for improvements, or would like to propose new features, feel free to contribute. Please open an issue in the repository or submit a pull request with your changes. + +## License + +This project is licensed under the [GNU General Public License v3.0](LICENSE). + +## Authors + +QuickNote was developed by Yet-Another-Dreamteam Group. You can reach us via admin@yet-another-dreamteam.de