Permalink
Browse files

update readme and export two variables

  • Loading branch information...
1 parent f1c3069 commit d0feeead9842d95980d23f1659c624cd5ee531a6 @nixeagle committed Feb 1, 2010
Showing with 15 additions and 0 deletions.
  1. +12 −0 README.org
  2. +3 −0 package.lisp
View
12 README.org
@@ -32,6 +32,18 @@ comfortable with maintaining.
object or they return a list of objects. In some extremely simple
cases, we return lists of strings or lists of other non CLOS objects.
+*** Quick start
+ Set the default login info in the repl. Doing this means you won't
+ have to pass a token and login to each function call.
+ : (setq clithub:*default-login* "name"
+ : clithub:*default-token* "apikey")
+
+ Then try a simple call like:
+ : (clithub:show-followers "your login")
+
+ See the documentation strings for information on all of the
+ functions.
+
* Testing
This is known to work on sbcl 1.0.34, however this library is not
using any sbcl specific features. Anything that can run drakma,
View
3 package.lisp
@@ -5,6 +5,9 @@
(:nicknames :nisp.github :github)
(:export
+ :*default-login*
+ :*default-token*
+
;; Following people related.
#:show-followers
#:show-following

0 comments on commit d0feeea

Please sign in to comment.