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/markdown_middleware | |
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/markdown_middleware')
-rw-r--r-- | examples/markdown_middleware/README.asciidoc | 15 | ||||
-rw-r--r-- | examples/markdown_middleware/README.md | 24 |
2 files changed, 15 insertions, 24 deletions
diff --git a/examples/markdown_middleware/README.asciidoc b/examples/markdown_middleware/README.asciidoc new file mode 100644 index 0000000..3881bfb --- /dev/null +++ b/examples/markdown_middleware/README.asciidoc @@ -0,0 +1,15 @@ += Middleware 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/video.html + +Cowboy will serve all the files you put in the `priv` directory. +If you request a `.html` file that has a corresponding `.md` file +that has been modified more recently than the `.html` file, the +Markdown file will be converted to HTML and served by Cowboy. diff --git a/examples/markdown_middleware/README.md b/examples/markdown_middleware/README.md deleted file mode 100644 index cc890fc..0000000 --- a/examples/markdown_middleware/README.md +++ /dev/null @@ -1,24 +0,0 @@ -Middleware 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/markdown_middleware_example/bin/markdown_middleware_example console -``` - -Then point your browser at -[http://localhost:8080/video.html](http://localhost:8080/video.html). - -Cowboy will serve all the files you put in the `priv` directory. -If you request a `.html` file that has a corresponding `.md` file -that has been modified more recently than the `.html` file, the -Markdown file will be converted to HTML and served by Cowboy. |