From 32cefe91625f4e80caa0da21773f4ec31d7dd6ca Mon Sep 17 00:00:00 2001
From: GhostwheeI <155011637+GhostwheeI@users.noreply.github.com>
Date: Thu, 4 Jun 2026 17:48:08 +0000
Subject: [PATCH] docs: update README.md for official release

- Add status badges (Version, Platform, PowerShell, License)
- Add Table of Contents
- Refine introductory text for a more professional presentation
---
 README.md | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 7d58f79..34d9646 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,30 @@
 # GW Router Logger
 
-`GW Router Logger` is a PowerShell syslog collector for Windows, designed for home labs, residential routers, and small-network troubleshooting.
+![Version](https://img.shields.io/badge/version-1.3.4-blue.svg)
+![Platform](https://img.shields.io/badge/platform-Windows-lightgrey.svg)
+![PowerShell](https://img.shields.io/badge/PowerShell-5.1+-blue.svg)
+![License](https://img.shields.io/badge/license-MIT-green.svg)
+
+`GW Router Logger` is a professionally built, full-featured PowerShell syslog collector for Windows. It is designed specifically for home labs, residential routers, and small-network troubleshooting.
 
 Current release: `v1.3.4`
 
 It focuses on the things that usually break first on normal Windows machines: elevation, pathing, firewall access, bind-address selection, log rollover, and clear on-screen status.
 
+## Table of Contents
+- [Why this exists](#why-this-exists)
+- [Highlights](#highlights)
+- [Requirements](#requirements)
+- [Quick Start](#quick-start)
+  - [Install](#install)
+  - [CLI script](#cli-script)
+- [Default behavior](#default-behavior)
+- [Log layout](#log-layout)
+- [Runtime controls](#runtime-controls)
+- [Project goals](#project-goals)
+- [Notes](#notes)
+- [License](#license)
+
 ## Why this exists
 
 A lot of router logging tools assume too much:
@@ -143,6 +162,7 @@ While the listener is running:
 
 ## Notes
 
+- The project is fully self-contained. The CLI and tray mode share the same entry point.
 - The script is intentionally PowerShell-first and Windows-focused.
 - The UI is designed to be readable during real use, not overloaded with animation while logs are arriving.
 - Defaults can be adjusted from the built-in `Change defaults` menu.