README.asciidoc 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637
  1. = Cowboy
  2. Cowboy is a small, fast and modern HTTP server for Erlang/OTP.
  3. == Goals
  4. Cowboy aims to provide a *complete* HTTP stack in a *small* code base.
  5. It is optimized for *low latency* and *low memory usage*, in part
  6. because it uses *binary strings*.
  7. Cowboy provides *routing* capabilities, selectively dispatching requests
  8. to handlers written in Erlang.
  9. Because it uses Ranch for managing connections, Cowboy can easily be
  10. *embedded* in any other application.
  11. Cowboy is *clean* and *well tested* Erlang code.
  12. == Online documentation
  13. * http://ninenines.eu/docs/en/cowboy/2.0/guide[User guide]
  14. * http://ninenines.eu/docs/en/cowboy/2.0/manual[Function reference]
  15. == Offline documentation
  16. * While still online, run `make docs`
  17. * User guide available in `doc/` in PDF and HTML formats
  18. * Function reference man pages available in `doc/man3/` and `doc/man7/`
  19. * Run `make install-docs` to install man pages on your system
  20. * Full documentation in Asciidoc available in `doc/src/`
  21. * Examples available in `examples/`
  22. == Getting help
  23. * Official IRC Channel: #ninenines on irc.freenode.net
  24. * https://github.com/ninenines/cowboy/issues[Issues tracker]
  25. * http://ninenines.eu/services[Commercial Support]