diff options
| author | Loïc Hoguin <[email protected]> | 2018-06-04 12:59:26 +0200 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2018-06-04 12:59:26 +0200 |
| commit | 2b588340af501825f3ab03f2e76dba0353c98fae (patch) | |
| tree | ad990a44d67f30e9804b606e0282ca9adfa37433 /docs/en/gun/1.0/guide/introduction.asciidoc | |
| parent | 791b95225695b3badff7cc4bb4f0f1ed373c74de (diff) | |
| download | ninenines.eu-2b588340af501825f3ab03f2e76dba0353c98fae.tar.gz ninenines.eu-2b588340af501825f3ab03f2e76dba0353c98fae.tar.bz2 ninenines.eu-2b588340af501825f3ab03f2e76dba0353c98fae.zip | |
Update documentation for Gun 1.0
Diffstat (limited to 'docs/en/gun/1.0/guide/introduction.asciidoc')
| -rw-r--r-- | docs/en/gun/1.0/guide/introduction.asciidoc | 38 |
1 files changed, 29 insertions, 9 deletions
diff --git a/docs/en/gun/1.0/guide/introduction.asciidoc b/docs/en/gun/1.0/guide/introduction.asciidoc index f437769a..f7cd9c10 100644 --- a/docs/en/gun/1.0/guide/introduction.asciidoc +++ b/docs/en/gun/1.0/guide/introduction.asciidoc @@ -1,6 +1,9 @@ +[[introduction]] == Introduction -Gun is an Erlang HTTP client with support for HTTP/1.1, HTTP/2 and Websocket. +Gun is an HTTP client for Erlang/OTP. + +Gun supports the HTTP/2, HTTP/1.1 and Websocket protocols. === Prerequisites @@ -9,12 +12,33 @@ protocols is required in order to read this guide. === Supported platforms -Gun is tested and supported on Linux. +Gun is tested and supported on Linux, FreeBSD, Windows and OSX. + +Gun is developed for Erlang/OTP 19.0 and newer. + +=== License -Gun is developed for Erlang 19+. +Gun uses the ISC License. -Gun may be compiled on earlier Erlang versions with small source code -modifications but there is no guarantee that it will work as intended. +---- +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 @@ -26,7 +50,3 @@ 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/). |