diff --git a/README.md b/README.md index e522500..da6530e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # TeamspeakStats [![Build Status](https://travis-ci.org/Thor77/TeamspeakStats.svg?branch=master)](https://travis-ci.org/Thor77/TeamspeakStats) [![Coverage Status](https://coveralls.io/repos/Thor77/TeamspeakStats/badge.svg?branch=master&service=github)](https://coveralls.io/github/Thor77/TeamspeakStats?branch=master) [![Code Health](https://landscape.io/github/Thor77/TeamspeakStats/master/landscape.svg?style=flat)](https://landscape.io/github/Thor77/TeamspeakStats/master) [![PyPI](https://img.shields.io/pypi/v/tsstats.svg)](https://pypi.python.org/pypi/tsstats) [![Documentation Status](https://readthedocs.org/projects/teamspeakstats/badge/?version=latest)](http://teamspeakstats.readthedocs.io/en/latest/?badge=latest) -A simple Teamspeak stat-generator - based on server-logs +A simple Teamspeak stat-generator - based solely on server-logs ![screenshot](screenshot.png) @@ -11,20 +11,21 @@ A simple Teamspeak stat-generator - based on server-logs # Usage - Run the script `tsstats [-h]` - Optionally create a config-file (see [Configuration](https://github.com/Thor77/TeamspeakStats#configuration)) +- The package works entirely off your Teamspeak server's logs, so that no ServerQuery account is necessary # 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` +Parse logs matching `ts3server*.log` in `/var/log/teamspeak3-server` and write output to `/var/www/tsstats.html`. # CLI-Usage ``` usage: tsstats [-h] [-c CONFIG] [--idmap IDMAP] [-l LOG] [-o OUTPUT] [-d] [-nod] -A simple Teamspeak stats-generator - based on server-logs +A simple Teamspeak stats-generator - based solely on server-logs optional arguments: -h, --help show this help message and exit