aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.rst17
-rw-r--r--github3/core.py20
2 files changed, 29 insertions, 8 deletions
diff --git a/README.rst b/README.rst
index dfd59ec..7958179 100644
--- a/README.rst
+++ b/README.rst
@@ -7,12 +7,19 @@ This is going to be awesome.
-Dependencies
-------------
+Usage
+-----
+
+::
+ from github3 import github
+
+ github.login('username', 'password')
+ # optional
+
+ github.
+
+
-- Requests
-- AnyJSON
-- OrderedDict
Installation
diff --git a/github3/core.py b/github3/core.py
index 65b6ca0..383ab88 100644
--- a/github3/core.py
+++ b/github3/core.py
@@ -9,8 +9,22 @@ This module contains the core GitHub 3 interface.
"""
+from .api import API_URL
+
+
+
class GitHub(object):
- pass
+ """Central GitHub object."""
+
+ ratelimit = None
+ = None
+
+ def __init__(self, apiurl=API_URL):
+ pass
+
+ def login(self):
+ pass
+
- def __init__(self):
- pass \ No newline at end of file
+# Default instance
+github = GitHub() \ No newline at end of file