path: root/README.asciidoc
diff options
authorLoïc Hoguin <[email protected]>2016-09-30 18:19:55 +0200
committerLoïc Hoguin <[email protected]>2016-09-30 18:19:55 +0200
commite296f13d2432131c9349cfaa1ab634efcd758027 (patch)
tree4bad4fdb1773fc72ebc8b825cc5b9d41c69778ce /README.asciidoc
parent5477d613f96c2c9f9ce53aa22944e3254c1da6e3 (diff)
Update README and convert to Asciidoc
Diffstat (limited to 'README.asciidoc')
1 files changed, 44 insertions, 0 deletions
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]