diff options
author | Loïc Hoguin <[email protected]> | 2016-05-24 14:50:27 +0200 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2016-05-24 14:50:27 +0200 |
commit | b5a40256ddd5585d12c2a01771eb93d4a8630a62 (patch) | |
tree | 9d03e630d501852b216a8b7990a1d03a02e9f4dd /doc/src/guide/introduction.asciidoc | |
parent | 25912dfc05e45e0f4453f689410fce80a1af69ab (diff) | |
download | cowboy-b5a40256ddd5585d12c2a01771eb93d4a8630a62.tar.gz cowboy-b5a40256ddd5585d12c2a01771eb93d4a8630a62.tar.bz2 cowboy-b5a40256ddd5585d12c2a01771eb93d4a8630a62.zip |
Partial update of the user guide
I will do more breaking changes before documenting more.
Diffstat (limited to 'doc/src/guide/introduction.asciidoc')
-rw-r--r-- | doc/src/guide/introduction.asciidoc | 23 |
1 files changed, 10 insertions, 13 deletions
diff --git a/doc/src/guide/introduction.asciidoc b/doc/src/guide/introduction.asciidoc index 9cdcbc9..0179c16 100644 --- a/doc/src/guide/introduction.asciidoc +++ b/doc/src/guide/introduction.asciidoc @@ -3,9 +3,13 @@ Cowboy is a small, fast and modular HTTP server written in Erlang. -Cowboy aims to provide a complete HTTP stack, including its derivatives -Websocket and REST. Cowboy currently supports HTTP/1.0, HTTP/1.1, HTTP/2, -Websocket (all implemented drafts + standard) and Webmachine-based REST. +Cowboy aims to provide a complete xref:modern_web[modern Web stack]. +This includes HTTP/1.1, HTTP/2, Websocket, Server-Sent Events and +Webmachine-based REST. + +Cowboy comes with functions for introspection and tracing, enabling +developers to know precisely what is happening at any time. Its modular +design also easily enable developers to add instrumentation. Cowboy is a high quality project. It has a small code base, is very efficient (both in latency and memory use) and can easily be embedded @@ -13,7 +17,7 @@ in another application. Cowboy is clean Erlang code. It includes hundreds of tests and its code is fully compliant with the Dialyzer. It is also well documented and -features both a Function Reference and a User Guide. +features a Function Reference, a User Guide and numerous Tutorials. === Prerequisites @@ -24,21 +28,14 @@ will be detailed throughout the guide. === Supported platforms -Cowboy is tested and supported on Linux. +Cowboy is tested and supported on Linux, FreeBSD, Windows and OSX. Cowboy has been reported to work on other platforms, but we make no guarantee that the experience will be safe and smooth. You are advised to perform the necessary testing and security audits prior to deploying on other platforms. -Cowboy is developed for Erlang/OTP 17.0, 17.1.2 and 17.3. By the time -this branch gets released the target version will probably be 18.0 and -above. - -Cowboy may be compiled on other Erlang versions with small source code -modifications but there is no guarantee that it will work as expected. - -Cowboy uses the maps data type which was introduced in Erlang 17.0. +Cowboy is developed for Erlang/OTP 18.0 and newer. === Versioning |