Add Example-section to showcase common calls

Thor77 · Oct 30, 2016 · 419164f · 419164f
1 parent 96ffef1
commit 419164f
Showing 1 changed file with 7 additions and 0 deletions.
diff --git 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]