diff --git a/servant/README.md b/README.md similarity index 73% rename from servant/README.md rename to README.md index 4d76a7d7..cc0d007d 100644 --- a/servant/README.md +++ b/README.md @@ -21,8 +21,8 @@ We've written a [Getting Started](http://haskell-servant.github.io/getting-start ## Repositories and Haddocks -- The core [servant](http://github.com/haskell-servant) package - [docs](http://hackage.haskell.org/package/servant) -- 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) -- (Haskell) client-side function generation with [servant-client](http://github.com/haskell-servant/servant-client) - [docs](http://hackage.haskell.org/package/servant-client) -- (Javascript) client-side function generation with [servant-jquery](http://github.com/haskell-servant/servant-jquery) - [docs](http://hackage.haskell.org/package/servant-jquery) -- API docs generation with [servant-docs](http://github.com/haskell-servant/servant-docs) - [docs](http://hackage.haskell.org/package/servant-docs) +- The core [servant](http://github.com/haskell-servant/tree/master/servant) package - [docs](http://hackage.haskell.org/package/servant) +- 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) +- (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) +- (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) +- API docs generation with [servant-docs](http://github.com/haskell-servant/servant/tree/master/servant-docs) - [docs](http://hackage.haskell.org/package/servant-docs) diff --git a/servant-client/README.md b/servant-client/README.md index b8ec46a5..0a2f1e32 100644 --- a/servant-client/README.md +++ b/servant-client/README.md @@ -1,8 +1,5 @@ # servant-client -[![Build Status](https://secure.travis-ci.org/haskell-servant/servant-client.svg)](http://travis-ci.org/haskell-servant/servant-client) -[![Coverage Status](https://coveralls.io/repos/haskell-servant/servant-client/badge.svg)](https://coveralls.io/r/haskell-servant/servant-client) - ![servant](https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png) This 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] postNewBook :: Book -> BaseUrl -> EitherT String IO Book -- 'client' allows you to produce operations to query an API from a client. (getAllBooks :<|> postNewBook) = client myApi -``` \ No newline at end of file +``` diff --git a/servant-docs/README.md b/servant-docs/README.md index 28c450e7..ed088802 100644 --- a/servant-docs/README.md +++ b/servant-docs/README.md @@ -1,14 +1,12 @@ # servant-docs -[![Build Status](https://secure.travis-ci.org/haskell-servant/servant-docs.svg)](http://travis-ci.org/haskell-servant/servant-docs) - ![servant](https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png) Generate 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**. ## Example -See [here](https://github.com/haskell-servant/servant-docs/blob/master/example/greet.md) for the output of the following program. +See [here](https://github.com/haskell-servant/servant/tree/master/servant-docs/blob/master/example/greet.md) for the output of the following program. ``` haskell {-# LANGUAGE DataKinds #-} diff --git a/servant-jquery/README.md b/servant-jquery/README.md index e4b47216..f6c6c7b8 100644 --- a/servant-jquery/README.md +++ b/servant-jquery/README.md @@ -1,15 +1,12 @@ # servant-jquery -[![Build Status](https://secure.travis-ci.org/haskell-servant/servant-jquery.svg)](http://travis-ci.org/haskell-servant/servant-jquery) -[![Coverage Status](https://coveralls.io/repos/haskell-servant/servant-jquery/badge.svg)](https://coveralls.io/r/haskell-servant/servant-jquery) - ![servant](https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png) This library lets you derive automatically (JQuery based) Javascript functions that let you query each endpoint of a *servant* webservice. ## Example -Read more about the following example [here](https://github.com/haskell-servant/servant-jquery/tree/master/examples#examples). +Read more about the following example [here](https://github.com/haskell-servant/servant/tree/master/servant-jquery/tree/master/examples#examples). ``` haskell {-# LANGUAGE DataKinds #-} @@ -53,7 +50,7 @@ currentValue counter = liftIO $ readTVarIO counter -- * Our API type type TestApi = "counter" :> Post Counter -- endpoint for increasing the counter :<|> "counter" :> Get Counter -- endpoint to get the current value - :<|> Raw -- used for serving static files + :<|> Raw -- used for serving static files testApi :: Proxy TestApi testApi = Proxy @@ -94,4 +91,4 @@ main = do -- listen to requests on port 8080 runServer cnt 8080 -``` \ No newline at end of file +``` diff --git a/servant-server/README.md b/servant-server/README.md index e998f1a9..78613e30 100644 --- a/servant-server/README.md +++ b/servant-server/README.md @@ -1,8 +1,5 @@ # servant-server -[![Build Status](https://secure.travis-ci.org/haskell-servant/servant-server.svg)](http://travis-ci.org/haskell-servant/servant-server) -[![Coverage Status](https://coveralls.io/repos/haskell-servant/servant-server/badge.svg)](https://coveralls.io/r/haskell-servant/servant-server) - ![servant](https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png) This 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 ## Repositories and Haddocks - The core [servant](http://github.com/haskell-servant) package - [docs](http://hackage.haskell.org/package/servant) -- 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) -- (Haskell) client-side function generation with [servant-client](http://github.com/haskell-servant/servant-client) - [docs](http://hackage.haskell.org/package/servant-client) -- (Javascript) client-side function generation with [servant-jquery](http://github.com/haskell-servant/servant-jquery) - [docs](http://hackage.haskell.org/package/servant-jquery) -- API docs generation with [servant-docs](http://github.com/haskell-servant/servant-docs) - [docs](http://hackage.haskell.org/package/servant-docs) +- 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) +- (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) +- (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) +- API docs generation with [servant-docs](http://github.com/haskell-servant/servant/tree/master/servant-docs) - [docs](http://hackage.haskell.org/package/servant-docs) diff --git a/servant/servant.png b/servant.png similarity index 100% rename from servant/servant.png rename to servant.png