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

Loïc Hoguin 8af3216c4c Document the HTTP/2 linger_timeout option 5 лет назад
doc 8af3216c4c Document the HTTP/2 linger_timeout option 5 лет назад
ebin 525eeeecc9 Cowboy 2.7.0 5 лет назад
examples 3977f2b96f Document the commands based Websocket interface 5 лет назад
src 775091134d Experiment with a linger_timeout for HTTP/2 5 лет назад
test b339713461 Allow {error, enotconn} as test success in security_SUITE 5 лет назад
.gitattributes 4023e7f4e4 Convert the documentation to Asciidoc 9 лет назад
.gitignore 306c2710e9 gitignore: add examples/ dependency files 9 лет назад
CONTRIBUTING.asciidoc 0704b2fa7c Document how to run all test suites 6 лет назад
LICENSE 43adacc760 Welcome to 2017 8 лет назад
Makefile 8471788826 Update Cowlib to 2.9.1 5 лет назад
README.asciidoc aa1a7d09f3 Add sponsor link to the README 5 лет назад
erlang.mk 27d10cf597 Update Erlang.mk 5 лет назад
plugins.mk 3977f2b96f Document the commands based Websocket interface 5 лет назад
rebar.config 909c8a4b4d Update rebar.config 5 лет назад

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.6/guide[User guide]
* https://ninenines.eu/docs/en/cowboy/2.6/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]
* https://github.com/sponsors/essen[Sponsor me!]