warped-0.0.1: README.md

[![warped][warped-img]][warped]

# [warped][warped]

[![Package version][hackage-img]][hackage]
[![Build status][travis-img]][travis]
[![Dependency status][deps-img]][deps]

Warped is a support library around WAI and the warp server.


## Development

`warped` has a shakefile/makefile to provide convience around building and testing:

    # build the project's libraries, executables, and tests
    $ ./Shakefile.hs build-tests-error
    
    # test the project
    $ ./Shakefile.hs tests-error
    
    # start an interpreter with the project's libraries, executables, and tests loaded
    $ ./Shakefile.hs ghci-tests
    
    # install the project's executables
    $ ./Shakefile.hs install
    
    # clean the project
    $ ./Shakefile.hs clean
    
    # lint the project source code
    $ ./Shakefile.hs lint
    
    # format the project source code
    $ ./Shakefile.hs format


## Dependencies

To build, install, run, and test `warped`, the following dependencies may be required:

+ [stack][stack]


[warped]:      https://github.com/swift-nav/warped
[warped-img]:  https://cloud.githubusercontent.com/assets/60851/8178609/a077a326-13c4-11e5-9d54-3e417fc6dd6c.jpg
[hackage]:     https://hackage.haskell.org/package/warped
[hackage-img]: https://img.shields.io/hackage/v/warped.svg?style=flat
[travis]:      https://travis-ci.org/swift-nav/warped
[travis-img]:  https://img.shields.io/travis/swift-nav/warped/master.svg?style=flat
[deps]:        http://packdeps.haskellers.com/feed?needle=warped
[deps-img]:    https://img.shields.io/hackage-deps/v/warped.svg?style=flat
[stack]:       https://docs.haskellstack.org/en/stable/README/#how-to-install