Permalink
Browse files

update the README.

  • Loading branch information...
nixeagle committed Feb 1, 2010
1 parent ef4da01 commit be2fc572a345733be13b512487f810afb520a692
Showing with 85 additions and 8 deletions.
  1. +27 −7 README.org
  2. +56 −0 README.txt
  3. +2 −1 package.lisp
View
@@ -1,16 +1,36 @@
-#+TITLE: github api
+#+TITLE: cl-github
Important! This library is not API stable! In general functions and
objects exported from [[file:package.lisp]] will not have their interfaces
changed without a major version increment. Anything else is subject to
my whim and fancy. Of course the idea is all functions end up exported
;).
-With that aside, the major principle we follow is functions either
-return a *single* 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.
-
-As of this writing [2010-01-30 Sat], all current v2 github APIs are
+As of this writing [2010-02-01 Mon], all current v2 github APIs are
implemented if not release ready or vetted for an interface I'm
comfortable with maintaining.
+
+* Dependencies
+ - [[http://common-lisp.net/project/cl-json/][CL-JSON]] - Translate github's api messages to CLOS or simple lists.
+ - [[http://weitz.de/drakma/][DRAKMA]] - HTTP support to talk to github.
+ - [[http://common-lisp.net/project/iterate/][Iterate]] - A better loop.
+
+* Overview
+ The whole public api can be used as of this release, however not all
+ of the function names or return results are finalized. Please see
+ [[file:package.lisp]] for functions that are currently exported and won't
+ change in terms of input or output without a depreciation cycle.
+
+ The major principle we follow is functions either return a *single*
+ 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.
+
+* 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,
+ cl-json, and iterate ought to run this library without any issues.
+
+* Bugs
+ Please report all bugs to github's tracker, found at
+ http://github.com/nixeagle/nisp/issues.
+
View
@@ -0,0 +1,56 @@
+ cl-github
+ =========
+
+
+
+Important! This library is not API stable! In general functions and
+objects exported from [file:package.lisp] will not have their interfaces
+changed without a major version increment. Anything else is subject to
+my whim and fancy. Of course the idea is all functions end up exported
+;).
+
+As of this writing [2010-02-01 Mon], all current v2 github APIs are
+implemented if not release ready or vetted for an interface I'm
+comfortable with maintaining.
+
+Table of Contents
+=================
+1 Dependencies
+2 Overview
+3 Testing
+4 Bugs
+
+
+1 Dependencies
+~~~~~~~~~~~~~~~
+ - [CL-JSON] - Translate github's api messages to CLOS or simple lists.
+ - [DRAKMA] - HTTP support to talk to github.
+ - [Iterate] - A better loop.
+
+
+ [CL-JSON]: http://common-lisp.net/project/cl-json/
+ [DRAKMA]: http://weitz.de/drakma/
+ [Iterate]: http://common-lisp.net/project/iterate/
+
+2 Overview
+~~~~~~~~~~~
+ The whole public api can be used as of this release, however not all
+ of the function names or return results are finalized. Please see
+ [file:package.lisp] for functions that are currently exported and won't
+ change in terms of input or output without a depreciation cycle.
+
+ The major principle we follow is functions either return a *single*
+ 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.
+
+3 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,
+ cl-json, and iterate ought to run this library without any issues.
+
+4 Bugs
+~~~~~~~
+ Please report all bugs to github's tracker, found at
+ [http://github.com/nixeagle/nisp/issues].
+
View
@@ -2,6 +2,7 @@
(defpackage #:cl-github
(:use :cl :json :iterate)
+ (:nicknames :nisp.github :github)
(:export
;; Following people related.
@@ -18,7 +19,7 @@
;; User Emails
#:user-emails
#:add-user-email
- #:remove-uer-email
+ #:remove-user-email
;; User keys
#:user-keys

0 comments on commit be2fc57

Please sign in to comment.