aboutsummaryrefslogtreecommitdiffstats
path: root/guide/introduction.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2013-08-23 23:20:34 +0200
committerLoïc Hoguin <[email protected]>2013-08-23 23:20:34 +0200
commit473dbb5ce698f5128858df1c85c33a696a0a0bbc (patch)
tree8eb307843169018944b2cb60f401c317bc224afc /guide/introduction.md
parentb4ba5a69fc7e60a51d8f42e6576c0bb090a720ba (diff)
downloadgun-473dbb5ce698f5128858df1c85c33a696a0a0bbc.tar.gz
gun-473dbb5ce698f5128858df1c85c33a696a0a0bbc.tar.bz2
gun-473dbb5ce698f5128858df1c85c33a696a0a0bbc.zip
First draft of the guide
Diffstat (limited to 'guide/introduction.md')
-rw-r--r--guide/introduction.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/guide/introduction.md b/guide/introduction.md
new file mode 100644
index 0000000..ca417ec
--- /dev/null
+++ b/guide/introduction.md
@@ -0,0 +1,35 @@
+Introduction
+============
+
+Purpose
+-------
+
+Gun is an asynchronous SPDY, HTTP and Websocket client.
+
+Prerequisites
+-------------
+
+Knowledge of Erlang, but also of the HTTP, 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 R16B+.
+
+Gun may be compiled on earlier Erlang versions with small source code
+modifications but there is no guarantee that it will work as expected.
+
+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 also.
+
+The same applies to any other case insensitive value.