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/compress_response/README.asciidoc | 63 +++++++++++++++++++++++++++ examples/compress_response/README.md | 70 ------------------------------ 2 files changed, 63 insertions(+), 70 deletions(-) create mode 100644 examples/compress_response/README.asciidoc delete mode 100644 examples/compress_response/README.md (limited to 'examples/compress_response') diff --git a/examples/compress_response/README.asciidoc b/examples/compress_response/README.asciidoc new file mode 100644 index 0000000..1e6d2ed --- /dev/null +++ b/examples/compress_response/README.asciidoc @@ -0,0 +1,63 @@ += Compressed response 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 + +== Example output + +Without compression: + +[source,bash] +---- +$ curl -i http://localhost:8080 +HTTP/1.1 200 OK +connection: keep-alive +server: Cowboy +date: Mon, 07 Jan 2013 18:42:29 GMT +content-length: 909 + +A cowboy is an animal herder who tends cattle on ranches in North America, +traditionally on horseback, and often performs a multitude of other ranch- +related tasks. The historic American cowboy of the late 19th century arose +from the vaquero traditions of northern Mexico and became a figure of special +significance and legend. A subtype, called a wrangler, specifically tends the +horses used to work cattle. In addition to ranch work, some cowboys work for +or participate in rodeos. Cowgirls, first defined as such in the late 19th +century, had a less-well documented historical role, but in the modern world +have established the ability to work at virtually identical tasks and obtained +considerable respect for their achievements. There are also cattle handlers +in many other parts of the world, particularly South America and Australia, +who perform work similar to the cowboy in their respective nations. +---- + +With compression: + +[source,bash] +---- +$ curl -i --compressed http://localhost:8080 +HTTP/1.1 200 OK +connection: keep-alive +server: Cowboy +date: Mon, 07 Jan 2013 18:42:30 GMT +content-encoding: gzip +content-length: 510 + +A cowboy is an animal herder who tends cattle on ranches in North America, +traditionally on horseback, and often performs a multitude of other ranch- +related tasks. The historic American cowboy of the late 19th century arose +from the vaquero traditions of northern Mexico and became a figure of special +significance and legend. A subtype, called a wrangler, specifically tends the +horses used to work cattle. In addition to ranch work, some cowboys work for +or participate in rodeos. Cowgirls, first defined as such in the late 19th +century, had a less-well documented historical role, but in the modern world +have established the ability to work at virtually identical tasks and obtained +considerable respect for their achievements. There are also cattle handlers +in many other parts of the world, particularly South America and Australia, +who perform work similar to the cowboy in their respective nations. +---- diff --git a/examples/compress_response/README.md b/examples/compress_response/README.md deleted file mode 100644 index ecffcad..0000000 --- a/examples/compress_response/README.md +++ /dev/null @@ -1,70 +0,0 @@ -Compressed response 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/compress_response_example/bin/compress_response_example console -``` - -Then point your browser at [http://localhost:8080](http://localhost:8080). - -Example output --------------- - -Without compression: - -``` bash -$ curl -i http://localhost:8080 -HTTP/1.1 200 OK -connection: keep-alive -server: Cowboy -date: Mon, 07 Jan 2013 18:42:29 GMT -content-length: 909 - -A cowboy is an animal herder who tends cattle on ranches in North America, -traditionally on horseback, and often performs a multitude of other ranch- -related tasks. The historic American cowboy of the late 19th century arose -from the vaquero traditions of northern Mexico and became a figure of special -significance and legend. A subtype, called a wrangler, specifically tends the -horses used to work cattle. In addition to ranch work, some cowboys work for -or participate in rodeos. Cowgirls, first defined as such in the late 19th -century, had a less-well documented historical role, but in the modern world -have established the ability to work at virtually identical tasks and obtained -considerable respect for their achievements. There are also cattle handlers -in many other parts of the world, particularly South America and Australia, -who perform work similar to the cowboy in their respective nations. -``` - -With compression: - -``` -$ curl -i --compressed http://localhost:8080 -HTTP/1.1 200 OK -connection: keep-alive -server: Cowboy -date: Mon, 07 Jan 2013 18:42:30 GMT -content-encoding: gzip -content-length: 510 - -A cowboy is an animal herder who tends cattle on ranches in North America, -traditionally on horseback, and often performs a multitude of other ranch- -related tasks. The historic American cowboy of the late 19th century arose -from the vaquero traditions of northern Mexico and became a figure of special -significance and legend. A subtype, called a wrangler, specifically tends the -horses used to work cattle. In addition to ranch work, some cowboys work for -or participate in rodeos. Cowgirls, first defined as such in the late 19th -century, had a less-well documented historical role, but in the modern world -have established the ability to work at virtually identical tasks and obtained -considerable respect for their achievements. There are also cattle handlers -in many other parts of the world, particularly South America and Australia, -who perform work similar to the cowboy in their respective nations. -``` -- cgit v1.2.3