Merge branch 'master' into show-contribution-new

Author: timvink

CONTRIBUTING.md

@@ -9,7 +9,7 @@ Make sure to install an editable version before running tests:
 ```python
 pip install -r tests/test_requirements.txt
 pip install -e .
-pytest --cov=mkdocs_git_authors_plugin --cov-report term-missing test 
+pytest --cov=mkdocs_git_authors_plugin --cov-report term-missing tests
 ```
 
 In addition, this project uses pyflakes for static code checking:
@@ -31,4 +31,4 @@ Make sure your code follows [PEP-8](https://www.python.org/dev/peps/pep-0008/) a
 
 #### Tests
 
-If it makes sense, writing tests for your PRs is always appreciated and will help get them merged.
+If it makes sense, writing tests for your PRs is always appreciated and will help get them merged.

README.md

@@ -53,7 +53,7 @@ Which renders as:
 
 ### In theme templates
 
-In theme templates you will have access to the jinja2 variable `git_authors`, which contains a list of authors dicts, like the following example:
+To add more detailed author information to your theme you can [customize a mkdocs theme](https://www.mkdocs.org/user-guide/styling-your-docs/#customizing-a-theme) or even [develop your own](https://www.mkdocs.org/user-guide/custom-themes/). When enabling this plugin, you will have access to the jinja2 variable `git_authors`, which contains a list of authors dicts, like the following example:
 
 ```python
 [{
@@ -99,3 +99,20 @@ Example output:
 * Authors: [John Doe](#) (33.33%), [Jane Doe](#) (66.67%) *(more than one author)*
 * Authors: [John Doe](#) *(one author)*
 
+### Aggregating Authors
+
+In some repositories authors may have committed with differing name/email combinations.
+In order to prevent the output being split it is possible to aggregate authors on
+arbitrary elements by providing a file `.mailmap` in the repository's root directory.
+This is a feature of Git itself. The following example will aggregate the contributions
+of Jane Doe committed under two email addresses:
+
+```
+# .mailmap
+Jane Doe <[email protected]> <[email protected]>
+```
+
+This will map commits made with the `private-email.com` to the company address. For more details
+and further options (e.g. mapping between different names or misspellings etc. see the
+[git-blame documentation](https://git-scm.com/docs/git-blame#_mapping_authors).
+

setup.py

@@ -14,7 +14,7 @@
     author='Tim Vink',
     author_email='[email protected]',
     license='MIT',
-    python_requires='>=3.4',
+    python_requires='>=3.5',
     classifiers=[
         "Programming Language :: Python :: 3",
         "License :: OSI Approved :: MIT License",