diff options
author | Loïc Hoguin <[email protected]> | 2015-03-25 13:44:08 +0100 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2015-03-25 13:44:08 +0100 |
commit | 83d8b63b8abb46b374439c8c8571091968af6260 (patch) | |
tree | 11a7bb370d43a7c25e4734eb7a6f7649ce9cdc61 /doc/src/guide/introduction.asciidoc | |
parent | eab45765497e6eb3e031cba5dad66a7a20ec3651 (diff) | |
download | gun-83d8b63b8abb46b374439c8c8571091968af6260.tar.gz gun-83d8b63b8abb46b374439c8c8571091968af6260.tar.bz2 gun-83d8b63b8abb46b374439c8c8571091968af6260.zip |
Update the guide
A number of @todo remain in it and will be worked on shortly.
The guide has been converted to Asciidoc and 'make asciidoc'
will generate a PDF and a chunked HTML version.
Diffstat (limited to 'doc/src/guide/introduction.asciidoc')
-rw-r--r-- | doc/src/guide/introduction.asciidoc | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/src/guide/introduction.asciidoc b/doc/src/guide/introduction.asciidoc new file mode 100644 index 0000000..ade3d80 --- /dev/null +++ b/doc/src/guide/introduction.asciidoc @@ -0,0 +1,28 @@ +== Introduction + +Gun is an Erlang HTTP client with support for HTTP/1.1, SPDY and Websocket. + +=== Prerequisites + +Knowledge of Erlang, but also of the HTTP/1.1, SPDY and Websocket +protocols is required in order to read this guide. + +=== Supported platforms + +Gun is tested and supported on Linux. + +Gun is developed for Erlang 17+. + +Gun may be compiled on earlier Erlang versions with small source code +modifications but there is no guarantee that it will work as intended. + +=== Conventions + +In the HTTP protocol, the method name is case sensitive. All standard +method names are uppercase. + +Header names are case insensitive. Gun converts all the header names +to lowercase, and expects your application to provide lowercase header +names. + +The same applies to any other case insensitive value. |