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

advertise installation via pypi and usage of entry-point

This commit is contained in:
Thor77 2016-05-11 20:40:23 +02:00
parent 4ebdf891c0
commit c25db473ec
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -4,13 +4,11 @@ A simple Teamspeak stat-generator - based on server-logs
![screenshot](screenshot.png) ![screenshot](screenshot.png)
# Installation # Installation
- Install a supported [Python](https://python.org)-version (`2.7`, `3.x`) - Install the package via PyPi `pip install tsstats`
- Clone this repo `git clone https://github.com/Thor77/TeamspeakStats`
- Install requirements `pip3 install -r requirements.txt`
# Usage # Usage
- Create a config (see [Configuration](https://github.com/Thor77/TeamspeakStats#configuration)) - Create a config (see [Configuration](https://github.com/Thor77/TeamspeakStats#configuration))
- Run the module `python -m tsstats` - Run the script `tsstats [-h]`
# Tests # Tests
- Install testing-requirements `pip install -r testing_requirements.txt` - Install testing-requirements `pip install -r testing_requirements.txt`
@ -18,7 +16,7 @@ A simple Teamspeak stat-generator - based on server-logs
# CMD-Arguments # CMD-Arguments
``` ```
usage: python -m tsstats [-h] [--config CONFIG] [--idmap IDMAP] [--debug] usage: tsstats [-h] [--config CONFIG] [--idmap IDMAP] [--debug]
A simple Teamspeak stats-generator - based on server-logs A simple Teamspeak stats-generator - based on server-logs