@@ -1,35 +1,19 @@
1−# servant
1+# servant - A Type-Level Web DSL
3−[](http://travis-ci.org/haskell-servant/servant)
4−[](https://coveralls.io/r/haskell-servant/servant)
6
3
8−These libraries provides a family of combinators to define webservices and
5+## Getting Started
9−automatically generate the documentation and client-side querying functions for
12−In order to minimize the dependencies depending on your needs, we provide these
13−features under different packages.
15−- `servant`, which contains everything you need to *declare* a webservice API.
7+We have a [tutorial](http://haskell-servant.github.io/tutorial) that
16−- `servant-server`, which lets you *implement* an HTTP server with handlers for
8+introduces the core features of servant. After this article, you should be able
17−each endpoint of an API.
9+to write your first servant webservices, learning the rest from the haddocks'
18−- `servant-client`, which lets you derive automatically Haskell functions that
10+examples.
19−let you query each endpoint of a `servant` webservice.
20−- `servant-docs`, which lets you generate API docs for your webservice.
21−- `servant-js`, which lets you derive Javascript functions (using vanilla JS
22−ajax requests, angular or jquery) to query your API's endpoints, in the same
23−spirit as `servant-client`.
24−- `servant-blaze` and `servant-lucid` provide easy HTML rendering of your data
25−as an `HTML` content-type "combinator".
27−## Tutorial
12+Other blog posts, videos and slides can be found on the
13+[website](http://haskell-servant.github.io/).
29−We have a [tutorial](http://haskell-servant.github.io/tutorial) guide that
15+If you need help, drop by the IRC channel (#servant on freenode) or [mailing
30−introduces the core types and features of servant. After this article, you
16+list](https://groups.google.com/forum/#!forum/haskell-servant).
31−should be able to write your first servant webservices, learning the rest from
32−the haddocks' examples.
34## Contributing
18## Contributing
@@ -58,3 +42,4 @@ files in the repository provide a good baseline for consistency.
59Please include a description of the changes in your PR in the `CHANGELOG.md` of
43Please include a description of the changes in your PR in the `CHANGELOG.md` of
60the packages you've changed. And of course, write tests!
44the packages you've changed. And of course, write tests!