git.iko.soy/servant
on master help sign in
Update READMEs
d418ed4Julian K. Arni
servant/README.md → README.mdrenamed+5−5
compare with master
unifiedsplit
@@ -21,8 +21,8 @@ We've written a [Getting Started](http://haskell-servant.github.io/getting-start
21
21
22## Repositories and Haddocks
22## Repositories and Haddocks
23
23
24−- The core [servant](http://github.com/haskell-servant) package - [docs](http://hackage.haskell.org/package/servant)
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-server) - [docs](http://hackage.haskell.org/package/servant-server)
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-client) - [docs](http://hackage.haskell.org/package/servant-client)
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-jquery) - [docs](http://hackage.haskell.org/package/servant-jquery)
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-docs) - [docs](http://hackage.haskell.org/package/servant-docs)
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 @@
1# servant-client
1# servant-client
2
2
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−
6![servant](https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png)
3![servant](https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png)
7
4
8This library lets you automatically derive Haskell functions that let you query each endpoint of a *servant* webservice.
5This 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]
20postNewBook :: Book -> BaseUrl -> EitherT String IO Book
17postNewBook :: Book -> BaseUrl -> EitherT String IO Book
21-- 'client' allows you to produce operations to query an API from a client.
18-- 'client' allows you to produce operations to query an API from a client.
22(getAllBooks :<|> postNewBook) = client myApi
19(getAllBooks :<|> postNewBook) = client myApi
23−```
20+```
servant-docs/README.md+1−3
@@ -1,14 +1,12 @@
1# servant-docs
1# servant-docs
2
2
3−[![Build Status](https://secure.travis-ci.org/haskell-servant/servant-docs.svg)](http://travis-ci.org/haskell-servant/servant-docs)
4−
5![servant](https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png)
3![servant](https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png)
6
4
7Generate 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**.
5Generate 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**.
8
6
9## Example
7## Example
10
8
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.
12
10
13``` haskell
11``` haskell
14{-# LANGUAGE DataKinds #-}
12{-# LANGUAGE DataKinds #-}
servant-jquery/README.md+3−6
@@ -1,15 +1,12 @@
1# servant-jquery
1# servant-jquery
2
2
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−
6![servant](https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png)
3![servant](https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png)
7
4
8This library lets you derive automatically (JQuery based) Javascript functions that let you query each endpoint of a *servant* webservice.
5This library lets you derive automatically (JQuery based) Javascript functions that let you query each endpoint of a *servant* webservice.
9
6
10## Example
7## Example
11
8
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).
13
10
14``` haskell
11``` haskell
15{-# LANGUAGE DataKinds #-}
12{-# LANGUAGE DataKinds #-}
@@ -53,7 +50,7 @@ currentValue counter = liftIO $ readTVarIO counter
53-- * Our API type
50-- * Our API type
54type TestApi = "counter" :> Post Counter -- endpoint for increasing the counter
51type TestApi = "counter" :> Post Counter -- endpoint for increasing the counter
55 :<|> "counter" :> Get Counter -- endpoint to get the current value
52 :<|> "counter" :> Get Counter -- endpoint to get the current value
56− :<|> Raw -- used for serving static files
53+ :<|> Raw -- used for serving static files
57
54
58testApi :: Proxy TestApi
55testApi :: Proxy TestApi
59testApi = Proxy
56testApi = Proxy
@@ -94,4 +91,4 @@ main = do
94
91
95 -- listen to requests on port 8080
92 -- listen to requests on port 8080
96 runServer cnt 8080
93 runServer cnt 8080
97−```
94+```
servant-server/README.md+4−7
@@ -1,8 +1,5 @@
1# servant-server
1# servant-server
2
2
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−
6![servant](https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png)
3![servant](https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png)
7
4
8This library lets you *implement* an HTTP server with handlers for each endpoint of a servant API, handling most of the boilerplate for you.
5This 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
14## Repositories and Haddocks
11## Repositories and Haddocks
15
12
16- The core [servant](http://github.com/haskell-servant) package - [docs](http://hackage.haskell.org/package/servant)
13- 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)
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)
18−- (Haskell) client-side function generation with [servant-client](http://github.com/haskell-servant/servant-client) - [docs](http://hackage.haskell.org/package/servant-client)
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)
19−- (Javascript) client-side function generation with [servant-jquery](http://github.com/haskell-servant/servant-jquery) - [docs](http://hackage.haskell.org/package/servant-jquery)
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)
20−- API docs generation with [servant-docs](http://github.com/haskell-servant/servant-docs) - [docs](http://hackage.haskell.org/package/servant-docs)
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.