Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 67 lines (51 sloc) 2.235 kb
be2fc572 »
2010-02-01 update the README.
1 cl-github
2 =========
3
4
5
6 Important! This library is not API stable! In general functions and
7 objects exported from [file:package.lisp] will not have their interfaces
8 changed without a major version increment. Anything else is subject to
9 my whim and fancy. Of course the idea is all functions end up exported
10 ;).
11
12 As of this writing [2010-02-01 Mon], all current v2 github APIs are
13 implemented if not release ready or vetted for an interface I'm
14 comfortable with maintaining.
15
16 Table of Contents
17 =================
18 1 Dependencies
07f94838 »
2010-02-01 Make sure hunchentoot gets some credit.
19 1.1 Some thanks
be2fc572 »
2010-02-01 update the README.
20 2 Overview
21 3 Testing
22 4 Bugs
23
24
25 1 Dependencies
26 ~~~~~~~~~~~~~~~
27 - [CL-JSON] - Translate github's api messages to CLOS or simple lists.
28 - [DRAKMA] - HTTP support to talk to github.
29 - [Iterate] - A better loop.
30
31
32 [CL-JSON]: http://common-lisp.net/project/cl-json/
33 [DRAKMA]: http://weitz.de/drakma/
34 [Iterate]: http://common-lisp.net/project/iterate/
35
07f94838 »
2010-02-01 Make sure hunchentoot gets some credit.
36 1.1 Some thanks
37 ================
38 This is not a direct dependency, however I made use of some encoding
39 functions in [hunchentoot] and its only right that I mention
40 Dr. Edmund Weitz's work which I selected 3 functions from and placed
41 in [file:url-utils.lisp] along with his copyright statement and
42 release under a BSD like license.
43
44
45 [hunchentoot]: http://weitz.de/hunchentoot
46
be2fc572 »
2010-02-01 update the README.
47 2 Overview
48 ~~~~~~~~~~~
49 The whole public api can be used as of this release, however not all
50 of the function names or return results are finalized. Please see
51 [file:package.lisp] for functions that are currently exported and won't
52 change in terms of input or output without a depreciation cycle.
53
54 The major principle we follow is functions either return a *single*
55 object or they return a list of objects. In some extremely simple
56 cases, we return lists of strings or lists of other non CLOS objects.
57
58 3 Testing
59 ~~~~~~~~~~
60 This is known to work on sbcl 1.0.34, however this library is not
61 using any sbcl specific features. Anything that can run drakma,
62 cl-json, and iterate ought to run this library without any issues.
63
64 4 Bugs
65 ~~~~~~~
66 Please report all bugs to github's tracker, found at
00d1e8f9 »
2010-02-01 forgot to update the README.txt... tagging v0.1.0 shortly afterwards.
67 [http://github.com/nixeagle/cl-github/issues].
be2fc572 »
2010-02-01 update the README.
68
Something went wrong with that request. Please try again.