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

Loïc Hoguin dcc6f9326f Fix some grammatical errors in the manual 6 лет назад
doc dcc6f9326f Fix some grammatical errors in the manual 6 лет назад
ebin 93e8744e22 Move cowboy_iolists to Cowlib as cow_iolists 7 лет назад
examples 6b1db885d1 Use cowboy_req:stream_events in the eventsource example 6 лет назад
src 0a5fadc60b Improve errors for when the ProvideCallback is missing 6 лет назад
test 0a5fadc60b Improve errors for when the ProvideCallback is missing 6 лет назад
.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 8d634d0ff4 See if recompiling ct_helper every time fixes ci builds 6 лет назад
README.asciidoc 8be6667a85 update doc 7 лет назад
erlang.mk aee40d5bb5 Update Erlang.mk 6 лет назад
plugins.mk a45813c60f Allow passing options to sub protocols 8 лет назад
rebar.config 06a3a93de0 Update Ranch to 1.6.1 6 лет назад

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.3/guide[User guide]
* https://ninenines.eu/docs/en/cowboy/2.3/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]