Mention login in the github config example [#97]

psss · Nov 16, 2016 · a3e72c5 · a3e72c5
1 parent b8ce803
commit a3e72c5
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/did/plugins/github.py b/did/plugins/github.py
@@ -8,11 +8,15 @@
     type = github
     url = https://api.github.com/
     token = <authentication-token>
+    login = <username>
 
 The authentication token is optional. However, unauthenticated
 queries are limited. For more details see `GitHub API`__ docs.
+Use ``login`` to override the default email address for searching.
+See the :doc:`config` documentation for details on using aliases.
 
 __ https://developer.github.com/guides/getting-started/#authentication
+
 """
 
 import re