update README to refflect the servant/servant-server split

This commit is contained in:
Alp Mestanogullari 2014-12-12 10:39:08 +01:00
parent 9aeb295955
commit 14a2750411

View file

@ -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. 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-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-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`. - `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 ## Repositories and Haddocks
- The core [servant](http://github.com/haskell-servant) package - [docs](http://haskell-servant.github.io/servant/) - 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/) - (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/) - (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/) - API docs generation with [servant-docs](http://github.com/haskell-servant/servant-docs) - [docs](http://haskell-servant.github.io/servant-docs/)