From e296f13d2432131c9349cfaa1ab634efcd758027 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Fri, 30 Sep 2016 18:19:55 +0200 Subject: Update README and convert to Asciidoc --- README.asciidoc | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 README.asciidoc (limited to 'README.asciidoc') diff --git a/README.asciidoc b/README.asciidoc new file mode 100644 index 0000000..f594066 --- /dev/null +++ b/README.asciidoc @@ -0,0 +1,44 @@ += 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. + +== Sponsors + +The project is currently sponsored by https://sameroom.io[Sameroom]. + +The original SPDY implementation was sponsored by +http://leo-project.net/leofs/[LeoFS Cloud Storage]. +It has since been superseded by HTTP/2. + +== 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 +* http://ninenines.eu/services[Commercial Support] -- cgit v1.2.3