summaryrefslogtreecommitdiffstats
path: root/docs/en/gun/1.1/guide/introduction.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2018-08-08 12:55:18 +0200
committerLoïc Hoguin <[email protected]>2018-08-08 12:55:18 +0200
commit87a857865a83c63412bb465a9a570a63f10af8f1 (patch)
treeaa0acd07626420d6cbf3551304b291b4900d5ce0 /docs/en/gun/1.1/guide/introduction.asciidoc
parenta63ee9b363aa7214343966690b50d77f4d3475e6 (diff)
downloadninenines.eu-87a857865a83c63412bb465a9a570a63f10af8f1.tar.gz
ninenines.eu-87a857865a83c63412bb465a9a570a63f10af8f1.tar.bz2
ninenines.eu-87a857865a83c63412bb465a9a570a63f10af8f1.zip
Gun 1.1
Diffstat (limited to 'docs/en/gun/1.1/guide/introduction.asciidoc')
-rw-r--r--docs/en/gun/1.1/guide/introduction.asciidoc52
1 files changed, 52 insertions, 0 deletions
diff --git a/docs/en/gun/1.1/guide/introduction.asciidoc b/docs/en/gun/1.1/guide/introduction.asciidoc
new file mode 100644
index 00000000..f7cd9c10
--- /dev/null
+++ b/docs/en/gun/1.1/guide/introduction.asciidoc
@@ -0,0 +1,52 @@
+[[introduction]]
+== Introduction
+
+Gun is an HTTP client for Erlang/OTP.
+
+Gun supports the HTTP/2, HTTP/1.1 and Websocket protocols.
+
+=== 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, FreeBSD, Windows and OSX.
+
+Gun is developed for Erlang/OTP 19.0 and newer.
+
+=== License
+
+Gun uses the ISC License.
+
+----
+Copyright (c) 2013-2018, Loïc Hoguin <[email protected]>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+----
+
+=== Versioning
+
+Gun uses http://semver.org/[Semantic Versioning 2.0.0].
+
+=== 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.