aboutsummaryrefslogtreecommitdiffstats
path: root/examples
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2016-01-14 20:09:01 +0100
committerLoïc Hoguin <[email protected]>2016-01-14 20:09:01 +0100
commit5dd9d877b1fe0a32cc32f1760a8520e7cd1c2ff6 (patch)
treecf37a5f4bb0c8c5fff249da9c1c09af1a2a7ddf2 /examples
parent6f8cb8225a1237e1cfe1a49512c88e5085f9aa93 (diff)
downloadcowboy-5dd9d877b1fe0a32cc32f1760a8520e7cd1c2ff6.tar.gz
cowboy-5dd9d877b1fe0a32cc32f1760a8520e7cd1c2ff6.tar.bz2
cowboy-5dd9d877b1fe0a32cc32f1760a8520e7cd1c2ff6.zip
Convert the example index README to AsciiDoc
Diffstat (limited to 'examples')
-rw-r--r--examples/README.asciidoc60
-rw-r--r--examples/README.md62
2 files changed, 60 insertions, 62 deletions
diff --git a/examples/README.asciidoc b/examples/README.asciidoc
new file mode 100644
index 0000000..965aba5
--- /dev/null
+++ b/examples/README.asciidoc
@@ -0,0 +1,60 @@
+= Cowboy examples
+
+* link:chunked_hello_world[]:
+ demonstrate chunked data transfer with two one-second delays
+
+* link:compress_response[]:
+ send a response body compressed if the client supports it
+
+* link:cookie[]:
+ set cookies from server and client side
+
+* link:echo_get[]:
+ parse and echo a GET query string
+
+* link:echo_post[]:
+ parse and echo a POST parameter
+
+* link:error_hook[]:
+ provide custom error pages
+
+* link:eventsource[]:
+ eventsource emitter and consumer
+
+* link:hello_world[]:
+ simplest example application
+
+* link:markdown_middleware[]:
+ static file handler with markdown preprocessor
+
+* link:rest_basic_auth[]:
+ basic HTTP authorization with REST
+
+* link:rest_hello_world[]:
+ return the data type that matches the request type (ex: html, text, json)
+
+* link:rest_pastebin[]:
+ create text objects and return the data type that matches the request type (html, text)
+
+* link:rest_stream_response[]:
+ stream results from a data store
+
+* link:ssl_hello_world[]:
+ simplest SSL application
+
+* link:static_world[]:
+ static file handler
+
+* link:upload[]:
+ multipart/form-data upload
+
+* link:web_server[]:
+ serve files with lists directory entries
+
+* link:websocket[]:
+ websocket example
+
+== Other languages
+
+* https://github.com/joshrotenberg/elixir_cowboy_examples[Elixir]
+* https://github.com/quasiquoting/lfe-cowboy-examples[LFE]
diff --git a/examples/README.md b/examples/README.md
deleted file mode 100644
index ee522a7..0000000
--- a/examples/README.md
+++ /dev/null
@@ -1,62 +0,0 @@
-Cowboy examples
-===============
-
- * [chunked_hello_world](./chunked_hello_world):
- demonstrate chunked data transfer with two one-second delays
-
- * [compress_response](./compress_response)
- send a response body compressed if the client supports it
-
- * [cookie](./cookie):
- set cookies from server and client side
-
- * [echo_get](./echo_get):
- parse and echo a GET query string
-
- * [echo_post](./echo_post):
- parse and echo a POST parameter
-
- * [error_hook](./error_hook):
- provide custom error pages
-
- * [eventsource](./eventsource):
- eventsource emitter and consumer
-
- * [hello_world](./hello_world):
- simplest example application
-
- * [markdown_middleware](./markdown_middleware):
- static file handler with markdown preprocessor
-
- * [rest_basic_auth](./rest_basic_auth):
- basic HTTP authorization with REST
-
- * [rest_hello_world](./rest_hello_world):
- return the data type that matches the request type (ex: html, text, json)
-
- * [rest_pastebin](./rest_pastebin):
- create text objects and return the data type that matches the request type (html, text)
-
- * [rest_stream_response](./rest_stream_response):
- stream results from a data store
-
- * [ssl_hello_world](./ssl_hello_world):
- simplest SSL application
-
- * [static_world](./static_world):
- static file handler
-
- * [upload](./upload):
- multipart/form-data upload
-
- * [web_server](./web_server):
- serve files with lists directory entries
-
- * [websocket](./websocket):
- websocket example
-
-Other languages
----------------
-
- * [elixir](https://github.com/joshrotenberg/elixir_cowboy_examples)
- * [lfe](https://github.com/quasiquoting/lfe-cowboy-examples)