aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/guide/introduction.asciidoc
blob: 89f2ae7176c35014ab3c4c47ccd28cebe7d17427 (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
== Introduction

Gun is an Erlang HTTP client with support for HTTP/1.1, HTTP/2 and Websocket.

=== Prerequisites

Knowledge of Erlang, but also of the HTTP/1.1, HTTP/2 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 18+.

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.

=== Versioning

Gun uses [Semantic Versioning 2.0.0](http://semver.org/).