From d5a26bd35820b1cb3de991fd45460345b9d3f492 Mon Sep 17 00:00:00 2001
From: David Medina <davidmedina9@gmail.com>
Date: Wed, 29 Feb 2012 01:22:16 +0100
Subject: Init documentation

+core
+services.user
~services.repos
---
 pygithub3/github.py | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

(limited to 'pygithub3/github.py')

diff --git a/pygithub3/github.py b/pygithub3/github.py
index 4941ffd..d05f069 100644
--- a/pygithub3/github.py
+++ b/pygithub3/github.py
@@ -6,7 +6,14 @@ from pygithub3.services.repos import Repo
 
 
 class Github(object):
-    """ Main entrance """
+    """
+    You can preconfigure all services globally with a ``config`` dict. See
+    :attr:`~pygithub3.services.base.Service`
+
+    Example::
+
+        gh = Github(user='kennethreitz', token='ABC...', repo='requests')
+    """
 
     def __init__(self, **config):
         self._users = User(**config)
@@ -14,8 +21,14 @@ class Github(object):
 
     @property
     def users(self):
+        """
+        :ref:`User service <User service>`
+        """
         return self._users
 
     @property
     def repos(self):
+        """
+        :ref:`Repos service <Repos service>`
+        """
         return self._repos
-- 
cgit v1.2.3-59-g8ed1b