servant-purescript-0.3.0.0: Readme.md

Servant Purescript
==================

[![Build Status](https://travis-ci.org/eskimor/servant-purescript.svg?branch=master)](https://travis-ci.org/eskimor/servant-purescript)

Generate typed PureScript query functions for your servant-api. Find an example, including
the generated code in [examples/central-counter](https://github.com/eskimor/servant-purescript/tree/master/examples/central-counter).

## Features

 - Typed serialization/deserialization taken care of by Haskell's aeson and PureScript's argonaut.
   Generic encoding/decoding of both made compatible by 
   [purescript-argonaut-generic-codecs](https://github.com/eskimor/purescript-argonaut-generic-codecs/blob/purescript-argonaut-generic-codec/src/Data/Argonaut/Generic/Aeson.purs).
 - You can put common parameters like Auth tokens and the base URL in a reader monad so you don't
   have to pass them explicitly. This is configurable in the code generator with `readerParams` in `Settings`.

## Status

It works!

Documentation is yet to come, but there is a usage example in
examples/central-counter which also uses servant-subscriber used for counter
live updates. Generated code is only partly tested, especially Query parameters
are completely untested.

For type translations purescript-bridge is used.

I now have to take care of my actual project, which makes use of servant-purescript,
improvements and documentation will follow on the way!