
---------------------------------------------------------------------

Cowboy

---------------------------------------------------------------------
---------------------------------------------------------------------

Table of Contents

1. Goals
2. Online documentation
3. Offline documentation
4. Getting help

Cowboy is a small, fast and modern HTTP server for Erlang/OTP.


---------------------------------------------------------------------

1. Goals

---------------------------------------------------------------------

Cowboy aims to provide a complete HTTP stack in a small code base. It
is optimized for low latency and low memory usage, in part because it
uses binary strings.

Cowboy provides routing capabilities, selectively dispatching
requests to handlers written in Erlang.

Because it uses Ranch for managing connections, Cowboy can easily be 
embedded in any other application.

Cowboy is clean and well tested Erlang code.


---------------------------------------------------------------------

2. Online documentation

---------------------------------------------------------------------

  * User guide
  * Function reference


---------------------------------------------------------------------

3. Offline documentation

---------------------------------------------------------------------

  * While still online, run make docs
  * User guide available in doc/ in PDF and HTML formats
  * Function reference man pages available in doc/man3/ and doc/man7/
  * Run make install-docs to install man pages on your system
  * Full documentation in Asciidoc available in doc/src/
  * Examples available in examples/


---------------------------------------------------------------------

4. Getting help

---------------------------------------------------------------------

  * Issues tracker
  * Commercial Support
  * Sponsor me!

