diff --git a/README.md b/README.md index ccdd6f5..accf416 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,23 @@ [![Feature](https://img.shields.io/badge/feature-journal_cleanup-0078D7)](#) [![License](https://img.shields.io/badge/License-MIT-green)](./LICENSE) -Automated Bash installer for **journal log rotation and cleanup** on Ubuntu 24.04 Server. +Auto-cleanup systemd journal logs on Ubuntu 24.04 server. -This script configures a scheduled **weekly cleanup of journalctl logs**, keeping the last **3 days** of system logs — enough for debugging without filling storage. +This is not a test script. +This is designed for stable long-term use with predictable disk usage. -Fire-and-forget. Install once, logs stay under control forever. +## Why this installer exists +System logs grow silently until they cause trouble. This prevents that automatically. + +## What this installer does +✔ Weekly rotation + vacuum cleanup +✔ Keeps only last 3 days of logs +✔ Lightweight, hands-off operation +✔ Fully automated via cron + +## What this installer does *NOT* do +It won’t stop you from running the script without reading the documentation like there’s no tomorrow. +Skip the README, and whatever happens next is your headache, not a bug report. ---