git.iko.soy/gogol
on 0.5.0 help sign in
gogol/README.md
68 lines 2.9 kB history raw
1# Gogol
3**Warning:** This is an experimental prototype/preview release which is still
4under heavy development and not intended for public consumption, caveat emptor!
6[![Build Status](https://img.shields.io/travis/brendanhay/gogol/develop.svg?maxAge=2592000)](https://travis-ci.org/brendanhay/gogol)
7[![Hackage Version](https://img.shields.io/hackage/v/gogol.svg)](http://hackage.haskell.org/package/gogol)
8[![Gitter Chat](https://img.shields.io/gitter/room/brendanhay/gogol.js.svg?maxAge=2592000)](https://gitter.im/brendanhay/gogol)
11* [Description](#description)
12* [Documentation](#documentation)
13* [Organisation](#organisation)
14* [Change Log](#change-log)
15* [Contribute](#contribute)
16* [Licence](#licence)
19## Description
21<img alt="Гоголь-моголь" height="261px;" src="https://upload.wikimedia.org/wikipedia/commons/c/c7/Kogel_mogel.JPG">
22<img alt="Мико́ла Васи́льович Го́голь" height="261px" src="https://upload.wikimedia.org/wikipedia/commons/3/31/NV_Gogol.png">
24A comprehensive Google Services SDK for Haskell supporting all of the publicly
25available services.
27An introductory blog post detailing the motivation can be found [here](http://brendanhay.nz/gogol-comprehensive-haskell-google-client).
29## Documentation
31You can find the latest stable release documentation for each respective library
32on Hackage under the [Google section](http://hackage.haskell.org/packages/#cat:Google).
34Haddock documentation which is built by CI from the `develop` branch
35can be found [here](http://brendanhay.nz/gogol-doc).
38## Organisation
40This repository is organised into the following directory structure:
42* [`gogol`](gogol): Actual operational logic, you'll need to import this to send requests etc.
43* `gogol-*`: Data types for each of the individual Google Compute Engine Service libraries.
44* [`core`](core): The `gogol-core` library upon which each of the services depends.
45* [`examples`](examples): A currently sparse collection of examples for the various services.
46* [`gen`](gen): The code generation binary, along with configuration, templates, and assets.
47* [`script`](script): CI scripts to manage the release lifecycle of the service libraries.
48* [`share`](share): Makefile plumbing common to all service libraries
50> See the `./gen` subdirectory for further details about generating an API client/SDK.
53## Change Log
55A change log for the entire project can be found under [`gogol/CHANGELOG.md`](gogol/CHANGELOG.md).
58## Contribute
60For any problems, comments, or feedback please create an issue [here on GitHub](https://github.com/brendanhay/gogol/issues).
63## Licence
65Gogol is released under the [Mozilla Public License Version 2.0](http://www.mozilla.org/MPL/).
67Parts of the code are derived from Google Compute Engine service descriptions, licensed under Apache 2.0.
68Source files subject to this contain an additional licensing clause in their header.