diff options
author | Loïc Hoguin <[email protected]> | 2016-01-14 20:00:50 +0100 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2016-01-14 20:00:50 +0100 |
commit | 394b4f0bf7f2a4d496ffe69c8e30cff153d69532 (patch) | |
tree | 82c3d7634f93596ec42b41050b4130805a359359 /examples/hello_world | |
parent | 4023e7f4e429179fd9c2cce4487c33646c6bd327 (diff) | |
download | cowboy-394b4f0bf7f2a4d496ffe69c8e30cff153d69532.tar.gz cowboy-394b4f0bf7f2a4d496ffe69c8e30cff153d69532.tar.bz2 cowboy-394b4f0bf7f2a4d496ffe69c8e30cff153d69532.zip |
Simplify example instructions and fix broken examples
Also convert to AsciiDoc while we're at it.
Diffstat (limited to 'examples/hello_world')
-rw-r--r-- | examples/hello_world/README.asciidoc | 25 | ||||
-rw-r--r-- | examples/hello_world/README.md | 33 |
2 files changed, 25 insertions, 33 deletions
diff --git a/examples/hello_world/README.asciidoc b/examples/hello_world/README.asciidoc new file mode 100644 index 0000000..66a6bd6 --- /dev/null +++ b/examples/hello_world/README.asciidoc @@ -0,0 +1,25 @@ += Hello world 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 + +[source,bash] +---- +$ curl -i http://localhost:8080 +HTTP/1.1 200 OK +connection: keep-alive +server: Cowboy +date: Fri, 28 Sep 2012 04:10:25 GMT +content-length: 12 +content-type: text/plain + +Hello world! +---- diff --git a/examples/hello_world/README.md b/examples/hello_world/README.md deleted file mode 100644 index 1e5be0e..0000000 --- a/examples/hello_world/README.md +++ /dev/null @@ -1,33 +0,0 @@ -Hello world 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/hello_world_example/bin/hello_world_example console -``` - -Then point your browser at [http://localhost:8080](http://localhost:8080). - -Example output --------------- - -``` bash -$ curl -i http://localhost:8080 -HTTP/1.1 200 OK -connection: keep-alive -server: Cowboy -date: Fri, 28 Sep 2012 04:10:25 GMT -content-length: 12 -content-type: text/plain - -Hello world! -``` |