README.asciidoc 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  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. == Sponsors
  13. The project is currently sponsored by https://sameroom.io[Sameroom].
  14. The original SPDY implementation was sponsored by
  15. http://leo-project.net/leofs/[LeoFS Cloud Storage].
  16. It has since been superseded by HTTP/2.
  17. == Online documentation
  18. * http://ninenines.eu/docs/en/cowboy/2.0/guide[User guide]
  19. * http://ninenines.eu/docs/en/cowboy/2.0/manual[Function reference]
  20. == Offline documentation
  21. * While still online, run `make docs`
  22. * User guide available in `doc/` in PDF and HTML formats
  23. * Function reference man pages available in `doc/man3/` and `doc/man7/`
  24. * Run `make install-docs` to install man pages on your system
  25. * Full documentation in Asciidoc available in `doc/src/`
  26. * Examples available in `examples/`
  27. == Getting help
  28. * Official IRC Channel: #ninenines on irc.freenode.net
  29. * http://ninenines.eu/services[Commercial Support]