servant/servant-jquery/examples/README.md

# Examples

## counter

This example demonstrates a *servant* server that holds a shared variable (using a `TVar`) and exposes an endpoint for reading its current value and another one for increasing its current value by 1.

In addition to that, it shows how you can generate the jquery-powered javascript functions corresponding to each endpoint, i.e one for reading the current value and one for increasing the value, and integrates all of that in a very simple HTML page. All these static files are served using the `serveDirectory` function from *servant*.

To see this all in action, simply run:

``` bash
$ cabal run counter
```

And point your browser to [http://localhost:8080/index.html](http://localhost:8080/index.html).

Copies of the generated javascript functions and of the generated docs are included in `www/api.js` and `counter.md` respectively.
add an example for servant-jquery: a shared counter whose value is updated via a button in an HTML page 2014-11-25 19:42:52 +01:00			`# Examples`

			`## counter`

			This example demonstrates a servant server that holds a shared variable (using a `TVar`) and exposes an endpoint for reading its current value and another one for increasing its current value by 1.

			In addition to that, it shows how you can generate the jquery-powered javascript functions corresponding to each endpoint, i.e one for reading the current value and one for increasing the value, and integrates all of that in a very simple HTML page. All these static files are served using the `serveDirectory` function from servant.

			`To see this all in action, simply run:`

			``` bash
			`$ cabal run counter`
			```

			`And point your browser to [http://localhost:8080/index.html](http://localhost:8080/index.html).`

small README tweak for the counter example 2014-11-25 19:43:44 +01:00			Copies of the generated javascript functions and of the generated docs are included in `www/api.js` and `counter.md` respectively.