1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
|
Github
------
The Github API v3 for Haskell.
Some functions are missing; these are functions where the Github API did
not work as expected. The full Github API is in beta and constantly
improving.
Installation
============
In your project's cabal file:
-- Packages needed in order to build this package.
Build-depends: github
Or from the command line:
cabal install github
Example Usage
=============
See the samples in the [samples/](https://github.com/fpco/github/tree/master/samples) directory.
Documentation
=============
For details see the reference documentation on Hackage.
Each module lines up with the hierarchy of [documentation from the Github API](http://developer.github.com/v3/).
Each function has a sample written for it.
All functions produce an `IO (Either Error a)`, where `a` is the actual thing you want. You must call the function using IO goodness, then dispatch on the possible error message. Here's an example from the samples:
import Github.Users.Followers
import Data.List (intercalate)
main = do
possibleUsers <- usersFollowing "mike-burns"
putStrLn $ either (\error -> "Error: " ++ $ show error)
(intercalate "\n" . map githubUserLogin)
possibleUsers
Contributions
=============
Please see [CONTRIBUTING.md](https://github.com/fpco/github/blob/master/CONTRIBUTING.md) for details on how you can help.
Copyright
=========
Copyright 2011, 2012 Mike Burns.
Available under the BSD 3-clause license.
|