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

Loïc Hoguin 353dc29d8f Fix protocol breaking when user tries to send empty chunk 8 years ago
doc f34ef2ceae Improve the manual for the new resp_header functions 8 years ago
ebin 1048bff929 Update rebar.config 8 years ago
examples b9ad02d305 Fix websocket example 8 years ago
src 353dc29d8f Fix protocol breaking when user tries to send empty chunk 8 years ago
test e5a8088e68 Make the new cowboy_req tests more realistic 8 years ago
.gitattributes 4023e7f4e4 Convert the documentation to Asciidoc 9 years ago
.gitignore 306c2710e9 gitignore: add examples/ dependency files 9 years ago
CHANGELOG.md 5be3c5064e Update CHANGELOG 10 years ago
CONTRIBUTING.asciidoc c37852fa2b Update CONTRIBUTING 9 years ago
LICENSE 43adacc760 Welcome to 2017 8 years ago
Makefile 637706ff1f Update Ranch to 1.3.0 8 years ago
README.asciidoc 0e2bd04cc9 Update README 8 years ago
erlang.mk fac882164c Update Erlang.mk 8 years ago
plugins.mk 5838a0c81a Add templates as Erlang.mk plugin 8 years ago
rebar.config 1048bff929 Update rebar.config 8 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

* http://ninenines.eu/docs/en/cowboy/2.0/guide[User guide]
* http://ninenines.eu/docs/en/cowboy/2.0/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]
* http://ninenines.eu/services[Commercial Support]