From 394b4f0bf7f2a4d496ffe69c8e30cff153d69532 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Thu, 14 Jan 2016 20:00:50 +0100 Subject: Simplify example instructions and fix broken examples Also convert to AsciiDoc while we're at it. --- examples/rest_stream_response/README.asciidoc | 67 ++++++++++++++++++++++++ examples/rest_stream_response/README.md | 74 --------------------------- 2 files changed, 67 insertions(+), 74 deletions(-) create mode 100644 examples/rest_stream_response/README.asciidoc delete mode 100644 examples/rest_stream_response/README.md (limited to 'examples/rest_stream_response') diff --git a/examples/rest_stream_response/README.asciidoc b/examples/rest_stream_response/README.asciidoc new file mode 100644 index 0000000..411c4c4 --- /dev/null +++ b/examples/rest_stream_response/README.asciidoc @@ -0,0 +1,67 @@ += REST streaming example + +To try this example, you need GNU `make` and `git` in your PATH. + +To build and run the example, use the following command: + +[source,bash] +$ make run + +Then point your browser to http://localhost:8080 + +== About + +This example simulates streaming a large amount of data from a data store one +record at a time in CSV format. It also uses a constraint to ensure that the +last segment of the route is an integer. + +== Example output + +Fetch records with the second field with value 1: + +[source,bash] +---- +$ curl -i localhost:8080 +HTTP/1.1 200 OK +transfer-encoding: identity +server: Cowboy +date: Sun, 10 Feb 2013 19:32:16 GMT +connection: close +content-type: text/csv + +DBUZGQ0C,1,28 +BgoQAxMV,1,6 +DAYEFxER,1,18 +... +---- + +Fetch records with the second field with value 4: + +[source,bash] +---- +$ curl -i localhost:8080/4 +HTTP/1.1 200 OK +transfer-encoding: identity +server: Cowboy +date: Sun, 10 Feb 2013 19:34:31 GMT +connection: close +content-type: text/csv + +ABcFDxcE,4,42 +DgYQCgEE,4,5 +CA8BBhYD,4,10 +... +---- + +Fail to use a proper integer and get an error: + +[source,bash] +---- +$ curl -i localhost:8080/foo +HTTP/1.1 404 Not Found +connection: keep-alive +server: Cowboy +date: Sun, 10 Feb 2013 19:36:16 GMT +content-length: 0 + +---- diff --git a/examples/rest_stream_response/README.md b/examples/rest_stream_response/README.md deleted file mode 100644 index 3b49451..0000000 --- a/examples/rest_stream_response/README.md +++ /dev/null @@ -1,74 +0,0 @@ -REST streaming example -====================== - -To try this example, you need GNU `make` and `git` in your PATH. - -To build the example, run the following command: - -``` bash -$ make -``` - -To start the release in the foreground: - -``` bash -$ ./_rel/rest_stream_response_example/bin/rest_stream_response_example console -``` - -Then point your browser at [http://localhost:8080](http://localhost:8080). - -About ------ - -This example simulates streaming a large amount of data from a data store one -record at a time in CSV format. It also uses a constraint to ensure that the -last segment of the route is an integer. - -Example output --------------- - -Fetch records with the second field with value 1: - -``` bash -$ curl -i localhost:8080 -HTTP/1.1 200 OK -transfer-encoding: identity -server: Cowboy -date: Sun, 10 Feb 2013 19:32:16 GMT -connection: close -content-type: text/csv - -DBUZGQ0C,1,28 -BgoQAxMV,1,6 -DAYEFxER,1,18 -... -``` - -Fetch records with the second field with value 4: - -``` bash -$ curl -i localhost:8080/4 -HTTP/1.1 200 OK -transfer-encoding: identity -server: Cowboy -date: Sun, 10 Feb 2013 19:34:31 GMT -connection: close -content-type: text/csv - -ABcFDxcE,4,42 -DgYQCgEE,4,5 -CA8BBhYD,4,10 -... -``` - -Fail to use a proper integer and get an error: - -``` bash -$ curl -i localhost:8080/foo -HTTP/1.1 404 Not Found -connection: keep-alive -server: Cowboy -date: Sun, 10 Feb 2013 19:36:16 GMT -content-length: 0 - -``` -- cgit v1.2.3