cowboy/guide/toc.md

Cowboy User Guide
=================

The Cowboy User Guide explores the modern Web and how to make
best use of Cowboy for writing powerful web applications.

Introducing Cowboy
------------------

 *  [Introduction](introduction.md)
   *  Purpose
   *  Prerequisites
   *  Supported platforms
   *  Conventions
 *  [The modern Web](modern_web.md)
   *  The prehistoric Web
   *  HTTP/1.1
   *  REST
   *  Long-polling
   *  HTML5
   *  EventSource
   *  Websocket
   *  SPDY
   *  HTTP/2.0
 *  [Erlang and the Web](erlang_web.md)
   *  The Web is concurrent
   *  The Web is soft real time
   *  The Web is asynchronous
   *  The Web is omnipresent
   *  Erlang is the ideal platform for the Web
 *  [Erlang for beginners](erlang_beginners.md)
 *  [Getting started](getting_started.md)

Using Cowboy
------------

 *  [Routing](routing.md)
   *  Purpose
   *  Structure
   *  Match syntax
   *  Constraints
   *  Compilation
   *  Live update
 *  [Handlers](handlers.md)
   *  Purpose
   *  Protocol upgrades
   *  Custom protocol upgrades
 *  [HTTP handlers](http_handlers.md)
   *  Purpose
   *  Usage
 *  [Loop handlers](loop_handlers.md)
   *  Purpose
   *  Usage
 *  [Websocket handlers](ws_handlers.md)
   *  Purpose
   *  Usage
 *  [REST handlers](rest_handlers.md)
   *  Purpose
   *  Usage
   *  Flow diagram
   *  Methods
   *  Callbacks
   *  Meta data
   *  Response headers
 *  [Static handlers](static_handlers.md)
   *  Purpose
   *  Usage
   *  MIME type
 *  [Request object](req.md)
   *  Purpose
   *  Request
   *  Request body
   *  Multipart request body
   *  Response
   *  Chunked response
   *  Response preconfiguration
   *  Closing the connection
   *  Reducing the memory footprint
 *  [Hooks](hooks.md)
   *  On request
   *  On response
 *  [Middlewares](middlewares.md)
   *  Purpose
   *  Usage
   *  Configuration
   *  Routing middleware
   *  Handler middleware
 *  [Internals](internals.md)
   *  Architecture
   *  One process for many requests
   *  Lowercase header names
   *  Improving performance
 *  [Resources](resources.md)
   *  Frameworks
   *  Helper libraries
   *  Articles
Add Introduction chapter to the guide 2012-10-15 14:35:52 +02:00			`Cowboy User Guide`
			`=================`

Greatly improve the guide introduction 2013-06-27 00:02:12 +02:00			`The Cowboy User Guide explores the modern Web and how to make`
			`best use of Cowboy for writing powerful web applications.`

			`Introducing Cowboy`
			`------------------`

Add Introduction chapter to the guide 2012-10-15 14:35:52 +02:00			`* [Introduction](introduction.md)`
			`* Purpose`
			`* Prerequisites`
Greatly improve the guide introduction 2013-06-27 00:02:12 +02:00			`* Supported platforms`
Add Introduction chapter to the guide 2012-10-15 14:35:52 +02:00			`* Conventions`
Greatly improve the guide introduction 2013-06-27 00:02:12 +02:00			`* [The modern Web](modern_web.md)`
			`* The prehistoric Web`
			`* HTTP/1.1`
			`* REST`
			`* Long-polling`
			`* HTML5`
			`* EventSource`
			`* Websocket`
			`* SPDY`
			`* HTTP/2.0`
			`* [Erlang and the Web](erlang_web.md)`
			`* The Web is concurrent`
			`* The Web is soft real time`
			`* The Web is asynchronous`
			`* The Web is omnipresent`
			`* Erlang is the ideal platform for the Web`
			`* [Erlang for beginners](erlang_beginners.md)`
			`* [Getting started](getting_started.md)`

			`Using Cowboy`
			`------------`

Add a skeleton of the guide to ease user contributions Has some stuff that aren't in master yet, and lacks a lot more that is already in master. 2013-01-01 18:27:41 +01:00			`* [Routing](routing.md)`
Add Introduction chapter to the guide 2012-10-15 14:35:52 +02:00			`* Purpose`
Add cowboy:set_env/3 2013-02-20 12:14:21 +01:00			`* Structure`
			`* Match syntax`
Cosmetic changes to various documentation files 2012-11-27 16:24:08 +01:00			`* Constraints`
Add cowboy:set_env/3 2013-02-20 12:14:21 +01:00			`* Compilation`
			`* Live update`
Add a skeleton of the guide to ease user contributions Has some stuff that aren't in master yet, and lacks a lot more that is already in master. 2013-01-01 18:27:41 +01:00			`* [Handlers](handlers.md)`
Add Introduction chapter to the guide 2012-10-15 14:35:52 +02:00			`* Purpose`
			`* Protocol upgrades`
Explain how to write custom protocol upgrades in the guide 2013-01-18 00:15:00 +01:00			`* Custom protocol upgrades`
Add a skeleton of the guide to ease user contributions Has some stuff that aren't in master yet, and lacks a lot more that is already in master. 2013-01-01 18:27:41 +01:00			`* [HTTP handlers](http_handlers.md)`
Add Introduction chapter to the guide 2012-10-15 14:35:52 +02:00			`* Purpose`
			`* Usage`
Add a skeleton of the guide to ease user contributions Has some stuff that aren't in master yet, and lacks a lot more that is already in master. 2013-01-01 18:27:41 +01:00			`* [Loop handlers](loop_handlers.md)`
Add Introduction chapter to the guide 2012-10-15 14:35:52 +02:00			`* Purpose`
			`* Usage`
Add a skeleton of the guide to ease user contributions Has some stuff that aren't in master yet, and lacks a lot more that is already in master. 2013-01-01 18:27:41 +01:00			`* [Websocket handlers](ws_handlers.md)`
Add Introduction chapter to the guide 2012-10-15 14:35:52 +02:00			`* Purpose`
			`* Usage`
Add a skeleton of the guide to ease user contributions Has some stuff that aren't in master yet, and lacks a lot more that is already in master. 2013-01-01 18:27:41 +01:00			`* [REST handlers](rest_handlers.md)`
Add Introduction chapter to the guide 2012-10-15 14:35:52 +02:00			`* Purpose`
Update the REST chapter of the guide 2013-04-26 14:12:29 +02:00			`* Usage`
Add Introduction chapter to the guide 2012-10-15 14:35:52 +02:00			`* Flow diagram`
Update the REST chapter of the guide 2013-04-26 14:12:29 +02:00			`* Methods`
Add Introduction chapter to the guide 2012-10-15 14:35:52 +02:00			`* Callbacks`
Update the REST chapter of the guide 2013-04-26 14:12:29 +02:00			`* Meta data`
			`* Response headers`
Add a skeleton of the guide to ease user contributions Has some stuff that aren't in master yet, and lacks a lot more that is already in master. 2013-01-01 18:27:41 +01:00			`* [Static handlers](static_handlers.md)`
Add Introduction chapter to the guide 2012-10-15 14:35:52 +02:00			`* Purpose`
			`* Usage`
Improve static file handler guide chapter Add more infos about MIME types and the file option. 2013-04-25 18:43:48 +02:00			`* MIME type`
Add a skeleton of the guide to ease user contributions Has some stuff that aren't in master yet, and lacks a lot more that is already in master. 2013-01-01 18:27:41 +01:00			`* [Request object](req.md)`
Add Introduction chapter to the guide 2012-10-15 14:35:52 +02:00			`* Purpose`
			`* Request`
			`* Request body`
First draft done for the request object guide chapter 2013-01-20 15:09:54 +01:00			`* Multipart request body`
Beginning of request object chapter in the guide 2013-01-18 18:04:21 +01:00			`* Response`
First draft done for the request object guide chapter 2013-01-20 15:09:54 +01:00			`* Chunked response`
			`* Response preconfiguration`
Add a section about closing the connection in the guide 2013-01-29 13:32:48 +01:00			`* Closing the connection`
First draft done for the request object guide chapter 2013-01-20 15:09:54 +01:00			`* Reducing the memory footprint`
Add a skeleton of the guide to ease user contributions Has some stuff that aren't in master yet, and lacks a lot more that is already in master. 2013-01-01 18:27:41 +01:00			`* [Hooks](hooks.md)`
Add Introduction chapter to the guide 2012-10-15 14:35:52 +02:00			`* On request`
			`* On response`
Add middleware support Middlewares allow customizing the request processing. All existing Cowboy project are incompatible with this commit. You need to change `{dispatch, Dispatch}` in the protocol options to `{env, [{dispatch, Dispatch}]}` to fix your code. 2013-01-03 22:47:51 +01:00			`* [Middlewares](middlewares.md)`
			`* Purpose`
			`* Usage`
			`* Configuration`
			`* Routing middleware`
			`* Handler middleware`
Add a skeleton of the guide to ease user contributions Has some stuff that aren't in master yet, and lacks a lot more that is already in master. 2013-01-01 18:27:41 +01:00			`* [Internals](internals.md)`
Add Introduction chapter to the guide 2012-10-15 14:35:52 +02:00			`* Architecture`
Finish up the Internals chapter 2013-01-18 20:22:49 +01:00			`* One process for many requests`
Add cowboy_bstr:capitalize_token/1 For optional header name capitalization. See the guide section about it. 2013-01-17 23:37:50 +01:00			`* Lowercase header names`
Finish up the Internals chapter 2013-01-18 20:22:49 +01:00			`* Improving performance`
Add a guide section for resource links 2013-03-22 19:59:35 +01:00			`* [Resources](resources.md)`
			`* Frameworks`
			`* Helper libraries`
			`* Articles`