mirror of
https://github.com/ninenines/cowboy.git
synced 2025-07-14 12:20:24 +00:00
078d686a0a
make docs: generate Markdown and man pages in doc/ make install-docs: install man pages to be usable directly Docs are generated from the ezdoc files in doc/src/.
50 lines
1.4 KiB
Markdown
50 lines
1.4 KiB
Markdown
Cowboy
|
|
======
|
|
|
|
Cowboy is a small, fast and modular HTTP server written in Erlang.
|
|
|
|
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.
|
|
|
|
No parameterized module. No process dictionary. **Clean** Erlang code.
|
|
|
|
Sponsors
|
|
--------
|
|
|
|
The SPDY implementation was sponsored by
|
|
[LeoFS Cloud Storage](http://www.leofs.org).
|
|
|
|
The project is currently sponsored by
|
|
[Kato.im](https://kato.im).
|
|
|
|
Online documentation
|
|
--------------------
|
|
|
|
* [User guide](http://ninenines.eu/docs/en/cowboy/HEAD/guide)
|
|
* [Function reference](http://ninenines.eu/docs/en/cowboy/HEAD/manual)
|
|
|
|
Offline documentation
|
|
---------------------
|
|
|
|
* While still online, run `make docs`
|
|
* 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 Markdown available in `doc/markdown/`
|
|
* Examples available in `examples/`
|
|
|
|
Getting help
|
|
------------
|
|
|
|
* Official IRC Channel: #ninenines on irc.freenode.net
|
|
* [Mailing Lists](http://lists.ninenines.eu)
|
|
* [Commercial Support](http://ninenines.eu/support)
|