mirror https://github.com/ninenines/cowboy

Loïc Hoguin ac07dbeb04 Update rebar.config 7 years ago
doc e23e12287a Add a new relevant RFC 7 years ago
ebin 8d49ae3dda Update Cowboy to 2.2.2 7 years ago
examples 58b70a594b Remove broken links from examples README 7 years ago
src 6945882cd3 Fix a Dialyzer warning 7 years ago
test 2131709328 Add case for handling infinity for idle/request_timeout 7 years ago
.gitattributes 4023e7f4e4 Convert the documentation to Asciidoc 9 years ago
.gitignore 306c2710e9 gitignore: add examples/ dependency files 9 years ago
CONTRIBUTING.asciidoc c37852fa2b Update CONTRIBUTING 9 years ago
LICENSE 43adacc760 Welcome to 2017 8 years ago
Makefile e4f1c332a3 Add a test suite for RFC7538; update Cowlib to 2.2.0 7 years ago
README.asciidoc 388a68fc2e Update Cowboy to 2.2.0 7 years ago
erlang.mk 344cec95b4 Add AUTO_CI_WINDOWS variable 7 years ago
plugins.mk a45813c60f Allow passing options to sub protocols 8 years ago
rebar.config ac07dbeb04 Update rebar.config 7 years ago

README.asciidoc

= Cowboy

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

== 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.

== Online documentation

* https://ninenines.eu/docs/en/cowboy/2.2/guide[User guide]
* https://ninenines.eu/docs/en/cowboy/2.2/manual[Function reference]

== 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/`

== Getting help

* Official IRC Channel: #ninenines on irc.freenode.net
* https://github.com/ninenines/cowboy/issues[Issues tracker]
* https://ninenines.eu/services[Commercial Support]