d418ed4 · typeable/servant

git.iko.soy/typeable/servant

Update READMEs

commitd418ed4b0ea3451451fdc09469d9880a68523eba authorJulian K. Arni <jkarni@gmail.com> dateMon 20 Apr 2015, 15:38 (11 years ago) parente9f73b0

6 files changed+14−25

compare with master

unifiedsplit

servant/README.md → README.md+5−5 servant-client/README.md+1−4 servant-docs/README.md+1−3 servant-jquery/README.md+3−6 servant-server/README.md+4−7 servant/servant.png → servant.png

servant/README.md → README.mdrenamed+5−5

@@ -21,8 +21,8 @@ We've written a [Getting Started](http://haskell-servant.github.io/getting-start

2121

2222## Repositories and Haddocks

2323

24−- The core [servant](http://github.com/haskell-servant) package - [docs](http://hackage.haskell.org/package/servant)

25−- Implementing an HTTP server for a webservice API with [servant-server](http://github.com/haskell-servant/servant-server) - [docs](http://hackage.haskell.org/package/servant-server)

26−- (Haskell) client-side function generation with [servant-client](http://github.com/haskell-servant/servant-client) - [docs](http://hackage.haskell.org/package/servant-client)

27−- (Javascript) client-side function generation with [servant-jquery](http://github.com/haskell-servant/servant-jquery) - [docs](http://hackage.haskell.org/package/servant-jquery)

28−- API docs generation with [servant-docs](http://github.com/haskell-servant/servant-docs) - [docs](http://hackage.haskell.org/package/servant-docs)

24+- The core [servant](http://github.com/haskell-servant/tree/master/servant) package - [docs](http://hackage.haskell.org/package/servant)

25+- Implementing an HTTP server for a webservice API with [servant-server](http://github.com/haskell-servant/servant/tree/master/servant-server) - [docs](http://hackage.haskell.org/package/servant-server)

26+- (Haskell) client-side function generation with [servant-client](http://github.com/haskell-servant/servant/tree/master/servant-client) - [docs](http://hackage.haskell.org/package/servant-client)

27+- (Javascript) client-side function generation with [servant-jquery](http://github.com/haskell-servant/servant/tree/master/servant-jquery) - [docs](http://hackage.haskell.org/package/servant-jquery)

28+- API docs generation with [servant-docs](http://github.com/haskell-servant/servant/tree/master/servant-docs) - [docs](http://hackage.haskell.org/package/servant-docs)

servant-client/README.md+1−4

@@ -1,8 +1,5 @@

11# servant-client

3−[![Build Status](https://secure.travis-ci.org/haskell-servant/servant-client.svg)](http://travis-ci.org/haskell-servant/servant-client)

4−[![Coverage Status](https://coveralls.io/repos/haskell-servant/servant-client/badge.svg)](https://coveralls.io/r/haskell-servant/servant-client)

5−

63![servant](https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png)

85This library lets you automatically derive Haskell functions that let you query each endpoint of a *servant* webservice.

@@ -20,4 +17,4 @@ getAllBooks :: BaseUrl -> EitherT String IO [Book]

2017postNewBook :: Book -> BaseUrl -> EitherT String IO Book

2118-- 'client' allows you to produce operations to query an API from a client.

2219(getAllBooks :<|> postNewBook) = client myApi

23−```

20+```

servant-docs/README.md+1−3

@@ -1,14 +1,12 @@

11# servant-docs

3−[![Build Status](https://secure.travis-ci.org/haskell-servant/servant-docs.svg)](http://travis-ci.org/haskell-servant/servant-docs)

4−

53![servant](https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png)

75Generate API docs for your *servant* webservice. Feel free to also take a look at [servant-pandoc](https://github.com/mpickering/servant-pandoc) which uses this package to target a broad range of output formats using the excellent **pandoc**.

97## Example

108

11−See [here](https://github.com/haskell-servant/servant-docs/blob/master/example/greet.md) for the output of the following program.

9+See [here](https://github.com/haskell-servant/servant/tree/master/servant-docs/blob/master/example/greet.md) for the output of the following program.

1210

1311``` haskell

1412{-# LANGUAGE DataKinds #-}

servant-jquery/README.md+3−6

@@ -1,15 +1,12 @@

11# servant-jquery

3−[![Build Status](https://secure.travis-ci.org/haskell-servant/servant-jquery.svg)](http://travis-ci.org/haskell-servant/servant-jquery)

4−[![Coverage Status](https://coveralls.io/repos/haskell-servant/servant-jquery/badge.svg)](https://coveralls.io/r/haskell-servant/servant-jquery)

5−

63![servant](https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png)

85This library lets you derive automatically (JQuery based) Javascript functions that let you query each endpoint of a *servant* webservice.

107## Example

118

12−Read more about the following example [here](https://github.com/haskell-servant/servant-jquery/tree/master/examples#examples).

9+Read more about the following example [here](https://github.com/haskell-servant/servant/tree/master/servant-jquery/tree/master/examples#examples).

1310

1411``` haskell

1512{-# LANGUAGE DataKinds #-}

@@ -53,7 +50,7 @@ currentValue counter = liftIO $ readTVarIO counter

5350-- * Our API type

5451type TestApi = "counter" :> Post Counter -- endpoint for increasing the counter

5552 :<|> "counter" :> Get Counter -- endpoint to get the current value

56− :<|> Raw -- used for serving static files

53+ :<|> Raw -- used for serving static files

5754

5855testApi :: Proxy TestApi

5956testApi = Proxy

@@ -94,4 +91,4 @@ main = do

9491

9592 -- listen to requests on port 8080

9693 runServer cnt 8080

97−```

94+```

servant-server/README.md+4−7

@@ -1,8 +1,5 @@

11# servant-server

3−[![Build Status](https://secure.travis-ci.org/haskell-servant/servant-server.svg)](http://travis-ci.org/haskell-servant/servant-server)

4−[![Coverage Status](https://coveralls.io/repos/haskell-servant/servant-server/badge.svg)](https://coveralls.io/r/haskell-servant/servant-server)

5−

63![servant](https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png)

85This library lets you *implement* an HTTP server with handlers for each endpoint of a servant API, handling most of the boilerplate for you.

@@ -14,7 +11,7 @@ We've written a [Getting Started](http://haskell-servant.github.io/getting-start

1411## Repositories and Haddocks

1512

1613- The core [servant](http://github.com/haskell-servant) package - [docs](http://hackage.haskell.org/package/servant)

17−- Implementing an HTTP server for a webservice API with [servant-server](http://github.com/haskell-servant/servant-server) - [docs](http://hackage.haskell.org/package/servant-server)

18−- (Haskell) client-side function generation with [servant-client](http://github.com/haskell-servant/servant-client) - [docs](http://hackage.haskell.org/package/servant-client)

19−- (Javascript) client-side function generation with [servant-jquery](http://github.com/haskell-servant/servant-jquery) - [docs](http://hackage.haskell.org/package/servant-jquery)

20−- API docs generation with [servant-docs](http://github.com/haskell-servant/servant-docs) - [docs](http://hackage.haskell.org/package/servant-docs)

14+- Implementing an HTTP server for a webservice API with [servant-server](http://github.com/haskell-servant/servant/tree/master/servant-server) - [docs](http://hackage.haskell.org/package/servant-server)

15+- (Haskell) client-side function generation with [servant-client](http://github.com/haskell-servant/servant/tree/master/servant-client) - [docs](http://hackage.haskell.org/package/servant-client)

16+- (Javascript) client-side function generation with [servant-jquery](http://github.com/haskell-servant/servant/tree/master/servant-jquery) - [docs](http://hackage.haskell.org/package/servant-jquery)

17+- API docs generation with [servant-docs](http://github.com/haskell-servant/servant/tree/master/servant-docs) - [docs](http://hackage.haskell.org/package/servant-docs)

servant/servant.png → servant.pngrenamed

Binary file not shown.