aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/guide/introduction.ezdoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2016-01-14 13:35:25 +0100
committerLoïc Hoguin <[email protected]>2016-01-14 13:37:20 +0100
commit4023e7f4e429179fd9c2cce4487c33646c6bd327 (patch)
tree3c4e26d1b5592958e35297c82ad3069bdb642594 /doc/src/guide/introduction.ezdoc
parentb7d666cfc746f55b0a72ef8d37f703885099daf7 (diff)
downloadcowboy-4023e7f4e429179fd9c2cce4487c33646c6bd327.tar.gz
cowboy-4023e7f4e429179fd9c2cce4487c33646c6bd327.tar.bz2
cowboy-4023e7f4e429179fd9c2cce4487c33646c6bd327.zip
Convert the documentation to Asciidoc
A few small revisions were made, and Erlang.mk has been updated.
Diffstat (limited to 'doc/src/guide/introduction.ezdoc')
-rw-r--r--doc/src/guide/introduction.ezdoc55
1 files changed, 0 insertions, 55 deletions
diff --git a/doc/src/guide/introduction.ezdoc b/doc/src/guide/introduction.ezdoc
deleted file mode 100644
index e1d2e60..0000000
--- a/doc/src/guide/introduction.ezdoc
+++ /dev/null
@@ -1,55 +0,0 @@
-::: Introduction
-
-Cowboy is a small, fast and modular HTTP server written in Erlang.
-
-Cowboy aims to provide a complete HTTP stack, including its derivatives
-SPDY, Websocket and REST. Cowboy currently supports HTTP/1.0, HTTP/1.1,
-Websocket (all implemented drafts + standard) and Webmachine-based REST.
-
-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
-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.
-
-:: Prerequisites
-
-Beginner Erlang knowledge is recommended for reading this guide.
-
-Knowledge of the HTTP protocol is recommended but not required, as it
-will be detailed throughout the guide.
-
-:: Supported platforms
-
-Cowboy is tested and supported on Linux.
-
-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.
-
-:: Versioning
-
-Cowboy uses ^"Semantic Versioning 2.0.0^http://semver.org/^.
-
-:: Conventions
-
-In the HTTP protocol, the method name is case sensitive. All standard
-method names are uppercase.
-
-Header names are case insensitive. Cowboy converts all the request
-header names to lowercase, and expects your application to provide
-lowercase header names in the response.
-
-The same applies to any other case insensitive value.