From 9c0ebc18ed27617887f334148b536aeef9378c2f Mon Sep 17 00:00:00 2001
From: Thor77 <xXThor77Xx@gmail.com>
Date: Fri, 20 May 2016 23:58:23 +0200
Subject: [PATCH] add documentation for IdentMap
---
docs/source/conf.py | 2 +-
docs/source/identmap.rst | 20 ++++++++++++++++++++
docs/source/index.rst | 1 +
setup.py | 2 +-
4 files changed, 23 insertions(+), 2 deletions(-)
create mode 100644 docs/source/identmap.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 9070c08..0608b9e 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -56,7 +56,7 @@ author = 'Thor77'
# The short X.Y version.
version = '0.2'
# The full version, including alpha/beta/rc tags.
-release = '0.2.5'
+release = '0.2.6'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
diff --git a/docs/source/identmap.rst b/docs/source/identmap.rst
new file mode 100644
index 0000000..e69da79
--- /dev/null
+++ b/docs/source/identmap.rst
@@ -0,0 +1,20 @@
+IdentMap
+********
+An IdentMap is used to map multiple (U)ID's of one client to one client.
+This can be useful, if a user creates multiple identities and you want to summarize all actions from all identities.
+
+TeamspeakStats' IdentMap-file is saved in json-format::
+
+ {
+ '2': '1',
+ '3': '1',
+ '4': '1'
+ }
+
+
+If you would pass this IdentMap to TeamspeakStats and your log would contain entries for clients with id's 1, 2, 3 and 4,
+your output will just show data for one client (1).
+
+To pass an IdentMap to TeamspeakStats, create your IdentMap as shown above and pass it to the cli::
+
+ tsstats --idmap <path to idmap.json>
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 148af80..df077dc 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -7,3 +7,4 @@ Contents:
:maxdepth: 2
api
+ identmap
diff --git a/setup.py b/setup.py
index 3e9a4c8..31835ad 100644
--- a/setup.py
+++ b/setup.py
@@ -2,7 +2,7 @@ from setuptools import setup
setup(
name='tsstats',
- version='0.2.5',
+ version='0.2.6',
author='Thor77',
author_email='thor77@thor77.org',
description='A simple Teamspeak stats-generator',