From 14a2750411d2c9c5c9aee5b8a2135ced3957d8c2 Mon Sep 17 00:00:00 2001 From: Alp Mestanogullari Date: Fri, 12 Dec 2014 10:39:08 +0100 Subject: [PATCH] update README to refflect the servant/servant-server split --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7d978b8a..bbcb168c 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,8 @@ These libraries provides a family of combinators to define webservices and autom In order to minimize the dependencies depending on your needs, we provide these features under different packages. -- `servant`, which contains everything you need to *declare* a webservice and *implement* an HTTP server with handlers for each endpoint. +- `servant`, which contains everything you need to *declare* a webservice API. +- `servant-server`, which lets you *implement* an HTTP server with handlers for each endpoint of an API. - `servant-client`, which lets you derive automatically Haskell functions that let you query each endpoint of a *servant* webservice. - `servant-docs`, which lets you generate API docs for your webservice. - `servant-jquery`, which lets you derive Javascript functions (based on jquery) to query your API's endpoints, in the same spirit as `servant-client`. @@ -20,6 +21,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://haskell-servant.github.io/servant/) +- Implementing an HTTP server for a webservice API with [servant-server](http://github.com/haskell-servant/servant-server) - [docs](http://haskell-servant.github.io/servant-server/) - (Haskell) client-side function generation with [servant-client](http://github.com/haskell-servant/servant-client) - [docs](http://haskell-servant.github.io/servant-client/) - (Javascript) client-side function generation with [servant-jquery](http://github.com/haskell-servant/servant-jquery) - [docs](http://haskell-servant.github.io/servant-jquery/) - API docs generation with [servant-docs](http://github.com/haskell-servant/servant-docs) - [docs](http://haskell-servant.github.io/servant-docs/)