diff --git a/README.md b/README.md index c9f8baf..454a830 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ -# log-archive-tool -The tool to archive logs from the CLI with the date and time. +# Log Archive Tool +The tool to archive logs from the CLI with the date and time. +[Roadmap.sh project page](https://roadmap.sh/projects/log-archive-tool) +## Installation ## +``` +git clone https://github.com/ami-chuu/log-archive-tool +cd log-archive-tool +chmod +x setup.sh +./setup.sh +``` +## Usage ## +``` +log-archive +``` +## Output ## +``` +Start archiving... +/var/log/nginx/access.log +/var/log/nginx/error.log +The archive has been saved at /var/log/log-archives/logs-archive_20251102_041057.tar.gz +```