0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-14 20:30:23 +00:00
Small, fast, modern HTTP server for Erlang/OTP.
Find a file
Loïc Hoguin c5a9771ac4
Remove ROADMAP file
The only ROADMAP now is small fixes toward making it stable
and very little interface changes, so the file is not that
useful anymore.
2017-01-02 19:42:47 +01:00
doc/src Welcome to 2017 2017-01-02 19:36:36 +01:00
ebin Partially update manual for the cowboy_req 2016-11-05 14:17:30 +02:00
examples Fix websocket example 2016-08-22 09:44:42 +02:00
src Welcome to 2017 2017-01-02 19:36:36 +01:00
test Welcome to 2017 2017-01-02 19:36:36 +01:00
.gitattributes Convert the documentation to Asciidoc 2016-01-14 13:37:20 +01:00
.gitignore gitignore: add examples/ dependency files 2016-05-25 12:54:12 +02:00
CHANGELOG.md Update CHANGELOG 2014-10-04 15:50:53 +03:00
CONTRIBUTING.asciidoc Update CONTRIBUTING 2015-11-16 18:55:53 +01:00
erlang.mk Update Erlang.mk 2017-01-02 19:28:48 +01:00
LICENSE Welcome to 2017 2017-01-02 19:36:36 +01:00
Makefile Update Ranch to 1.3.0 2017-01-02 16:47:54 +01:00
plugins.mk Add templates as Erlang.mk plugin 2016-12-28 17:54:50 +01:00
README.asciidoc Update README 2017-01-02 19:28:11 +01:00
rebar.config Partially update manual for the cowboy_req 2016-11-05 14:17:30 +02:00

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