Add configuration-setion to README
Configname, Sections, Keys and Examples
This commit is contained in:
parent
5e716d992d
commit
84b744608a
17
README.md
17
README.md
|
@ -1,2 +1,19 @@
|
||||||
# TeamspeakStats
|
# TeamspeakStats
|
||||||
A simple Teamspeak stat-generator - based on server-logs
|
A simple Teamspeak stat-generator - based on server-logs
|
||||||
|
|
||||||
|
# Configuration
|
||||||
|
|
||||||
|
###Configname
|
||||||
|
`config.ini`
|
||||||
|
###Sections
|
||||||
|
`[General]`
|
||||||
|
### Keys
|
||||||
|
- logfile `Path to TS3Server-logfile`
|
||||||
|
- outputfile `Path to the location, where the generator will put the generated .html-file`
|
||||||
|
|
||||||
|
## Example
|
||||||
|
```
|
||||||
|
[General]
|
||||||
|
logfile = /usr/local/bin/teamspeak-server/logs/ts3server_2015-03-02__14_01_43.110983_1.log
|
||||||
|
outputfile = /var/www/html/stats.html
|
||||||
|
```
|
||||||
|
|
Loading…
Reference in New Issue