Browse Source

Convert the example index README to AsciiDoc

Loïc Hoguin 9 years ago
parent
commit
5dd9d877b1
2 changed files with 60 additions and 62 deletions
  1. 60 0
      examples/README.asciidoc
  2. 0 62
      examples/README.md

+ 60 - 0
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]

+ 0 - 62
examples/README.md

@@ -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)