Claytonia/TeamspeakStats
Claytonia
/
TeamspeakStats
mirror of https://github.com/Thor77/TeamspeakStats.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update cli-help and config-keys in README.md 

* bump version to 0.6.3
This commit is contained in:
Thor77 2016-06-08 18:12:57 +02:00
parent ea5d997b5a
commit 6074fe0d63
3 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -16,15 +16,19 @@ A simple Teamspeak stat-generator - based on server-logs
# CMD-Arguments # CMD-Arguments
``` ```
usage: tsstats [-h] [--config CONFIG] [--idmap IDMAP] [--debug] usage: tsstats [-h] [-c CONFIG] [--idmap IDMAP] [-l LOG] [-o OUTPUT] [-d]
A simple Teamspeak stats-generator - based on server-logs A simple Teamspeak stats-generator - based on server-logs
optional arguments: optional arguments:
-h, --help show this help message and exit -h, --help show this help message and exit
--config CONFIG path to config -c CONFIG, --config CONFIG
--idmap IDMAP path to id_map path to config
--debug debug mode --idmap IDMAP path to id_map
-l LOG, --log LOG path to your logfile(s)
-o OUTPUT, --output OUTPUT
path to the output-file
-d, --debug debug mode
``` ```
# Configuration # Configuration
@ -34,11 +38,8 @@ optional arguments:
|-----|-------------| |-----|-------------|
| log | Path to TS3Server-logfile(s) (supports [globbing](https://docs.python.org/3/library/glob.html)) | | log | Path to TS3Server-logfile(s) (supports [globbing](https://docs.python.org/3/library/glob.html)) |
| output | Path to the location, where the generator will put the generated `.html`-file | | output | Path to the location, where the generator will put the generated `.html`-file |
| idmap | Path to [IdentMap](http://teamspeakstats.readthedocs.io/en/latest/identmap.html) |
#### [HTML] | debug | debug mode |
| Key | Description |
|-----|-------------|
| title | HTML-Title of the generated `.html`-file
## Example ## Example

2
docs/source/conf.py
View File

@ -56,7 +56,7 @@ author = 'Thor77'
# The short X.Y version. # The short X.Y version.
version = '0.6' version = '0.6'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '0.6.2' release = '0.6.3'
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.

2
setup.py
View File

@ -2,7 +2,7 @@ from setuptools import setup
setup( setup(
name='tsstats', name='tsstats',
version='0.6.2', version='0.6.3',
author='Thor77', author='Thor77',
author_email='thor77@thor77.org', author_email='thor77@thor77.org',
description='A simple Teamspeak stats-generator', description='A simple Teamspeak stats-generator',