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

Loïc Hoguin ad9ab51648 Add some todos 7 лет назад
doc f3d6b05b86 Add cowboy_req:inform/2,3 7 лет назад
ebin f4331f7c16 Add cowboy_tracer_h stream handler 7 лет назад
examples 58b70a594b Remove broken links from examples README 7 лет назад
src ad9ab51648 Add some todos 7 лет назад
test ad9ab51648 Add some todos 7 лет назад
.gitattributes 4023e7f4e4 Convert the documentation to Asciidoc 9 лет назад
.gitignore 306c2710e9 gitignore: add examples/ dependency files 9 лет назад
CONTRIBUTING.asciidoc c37852fa2b Update CONTRIBUTING 9 лет назад
LICENSE 43adacc760 Welcome to 2017 8 лет назад
Makefile d43bcb5cb3 Add OTP-20.1.2 to CI 7 лет назад
README.asciidoc d3f15cfd8b Make a few link use https 7 лет назад
erlang.mk 404ad037a1 Update Erlang.mk 7 лет назад
plugins.mk a45813c60f Allow passing options to sub protocols 8 лет назад
rebar.config 716a052b15 Update version, CI and Cowlib dependency version 7 лет назад

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.0/guide[User guide]
* https://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]
* https://ninenines.eu/services[Commercial Support]