Skip to content
Newer
Older
100644 56 lines (43 sloc) 2.29 KB
be2fc57 @nixeagle update the README.
authored
1 #+TITLE: cl-github
f0ca6df @nixeagle Add README.org and some notes on the github api that were strange to me.
authored
2
3 Important! This library is not API stable! In general functions and
4 objects exported from [[file:package.lisp]] will not have their interfaces
5 changed without a major version increment. Anything else is subject to
6 my whim and fancy. Of course the idea is all functions end up exported
7 ;).
8
be2fc57 @nixeagle update the README.
authored
9 As of this writing [2010-02-01 Mon], all current v2 github APIs are
f0ca6df @nixeagle Add README.org and some notes on the github api that were strange to me.
authored
10 implemented if not release ready or vetted for an interface I'm
11 comfortable with maintaining.
be2fc57 @nixeagle update the README.
authored
12
13 * Dependencies
14 - [[http://common-lisp.net/project/cl-json/][CL-JSON]] - Translate github's api messages to CLOS or simple lists.
15 - [[http://weitz.de/drakma/][DRAKMA]] - HTTP support to talk to github.
16 - [[http://common-lisp.net/project/iterate/][Iterate]] - A better loop.
17
07f9483 @nixeagle Make sure hunchentoot gets some credit.
authored
18 *** Some thanks
19 This is not a direct dependency, however I made use of some encoding
20 functions in [[http://weitz.de/hunchentoot][hunchentoot]] and its only right that I mention
21 Dr. Edmund Weitz's work which I selected 3 functions from and placed
22 in [[file:url-utils.lisp]] along with his copyright statement and
23 release under a BSD like license.
24
be2fc57 @nixeagle update the README.
authored
25 * Overview
26 The whole public api can be used as of this release, however not all
27 of the function names or return results are finalized. Please see
28 [[file:package.lisp]] for functions that are currently exported and won't
29 change in terms of input or output without a depreciation cycle.
30
31 The major principle we follow is functions either return a *single*
32 object or they return a list of objects. In some extremely simple
33 cases, we return lists of strings or lists of other non CLOS objects.
34
d0feeea @nixeagle update readme and export two variables
authored
35 *** Quick start
36 Set the default login info in the repl. Doing this means you won't
37 have to pass a token and login to each function call.
de859b3 @nixeagle Rename repo to cl-github
authored
38 : (setq cl-github:*default-login* "name"
39 : cl-github:*default-token* "apikey")
d0feeea @nixeagle update readme and export two variables
authored
40
41 Then try a simple call like:
de859b3 @nixeagle Rename repo to cl-github
authored
42 : (cl-github:show-followers "your login")
d0feeea @nixeagle update readme and export two variables
authored
43
44 See the documentation strings for information on all of the
45 functions.
46
be2fc57 @nixeagle update the README.
authored
47 * Testing
48 This is known to work on sbcl 1.0.34, however this library is not
49 using any sbcl specific features. Anything that can run drakma,
50 cl-json, and iterate ought to run this library without any issues.
51
52 * Bugs
53 Please report all bugs to github's tracker, found at
1db8bc4 @nixeagle issues go to cl-github now
authored
54 http://github.com/nixeagle/cl-github/issues.
be2fc57 @nixeagle update the README.
authored
55
Something went wrong with that request. Please try again.