0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-14 20:30:23 +00:00
cowboy/README.md

51 lines
1.4 KiB
Markdown
Raw Normal View History

2011-03-07 22:59:22 +01:00
Cowboy
======
Cowboy is a small, fast and modular HTTP server written in Erlang.
Goals
-----
2012-10-15 14:35:52 +02:00
Cowboy aims to provide a **complete** HTTP stack in a **small** code base.
2014-01-07 08:58:35 +11:00
It is optimized for **low latency** and **low memory usage**, in part
2012-10-15 14:35:52 +02:00
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.
2011-03-07 22:59:22 +01:00
2013-08-23 23:23:04 +02:00
Sponsors
--------
2014-04-14 12:09:56 +02:00
The SPDY implementation was sponsored by
[LeoFS Cloud Storage](http://www.leofs.org).
The project is currently sponsored by
[Kato.im](https://kato.im).
2013-08-23 23:23:04 +02:00
Online documentation
--------------------
2011-03-07 22:59:22 +01:00
* [User guide](http://ninenines.eu/docs/en/cowboy/HEAD/guide)
* [Function reference](http://ninenines.eu/docs/en/cowboy/HEAD/manual)
2012-10-15 14:35:52 +02:00
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)