Skip to content

docs: professional repository documentation updates #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
GhostwheeI wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: professional repository documentation updates #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Contributing

Thank you for your interest in contributing to GW Router Logger!

## Reporting Bugs
Please open an issue providing details about the bug and steps to reproduce.

## Pull Requests
1. Fork the repo and create your branch from `main`.
2. Ensure the script works natively on PowerShell 5.1+.
3. Update `README.md` if necessary.
4. Issue that pull request!
22 changes: 21 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -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.
Expand Down
7 changes: 7 additions & 0 deletions SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Security Policy

## Supported Versions
Only the latest version of `GW Router Logger` is supported.

## Reporting a Vulnerability
Please report any security issues via standard GitHub channels. Do not open public issues for severe vulnerabilities.