From 419164f3322e08a017b1d51e8e478f3ccaa56604 Mon Sep 17 00:00:00 2001 From: Thor77 Date: Sun, 30 Oct 2016 21:07:00 +0100 Subject: [PATCH] Add Example-section to showcase common calls --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 0c17016..df095ee 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,13 @@ A simple Teamspeak stat-generator - based on server-logs - Run the script `tsstats [-h]` - Optionally create a config-file (see [Configuration](https://github.com/Thor77/TeamspeakStats#configuration)) +# Example +``` +tsstats -l /var/log/teamspeak3-server/ts3server*.log -o /var/www/tsstats.html +``` + +Parse logs matching `ts3server*.log` in `/var/log/teamspeak3-server` and write output to `/var/www/tsstats.html` + # CMD-Arguments ``` usage: tsstats [-h] [-c CONFIG] [--idmap IDMAP] [-l LOG] [-o OUTPUT] [-d]