aboutsummaryrefslogtreecommitdiffstats
path: root/guide/introduction.md
blob: ca417ec2eb3672420ec77162fc783f34dfdf08ba (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
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.