## Notice

- Gun 2.0 has been prerelease for almost 2 years.
- Unable to publish packages to hex because gun is still rc.
- Similar to the now out of date grpc[fork]

### Installation

Add to your mix deps

  defp deps do
      {:gun, "~> 2.0", hex: :remedy_gun}


= Gun

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

== Goals

Gun aims to provide an *easy to use* client compatible with
HTTP/1.1, HTTP/2 and Websocket. Gun can connect through any
combination of Socks and HTTP proxies.

Gun is *always connected*. It will maintain a permanent
connection to the server, reopening it as soon as the server
closes it, saving time for the requests that come in.

All connections are *supervised* automatically, allowing
developers to focus on writing their code without worrying.

== Sponsors

The project is currently sponsored by[Pleroma].

The now removed SPDY implementation was sponsored by[LeoFS Cloud Storage].

It was previously sponsored by[Sameroom].

== Online documentation

*[User guide]
*[Function reference]

== Offline documentation

* While still online, run `make docs`
* User guide available in `doc/` in PDF and HTML formats
* Function reference man pages available in `doc/man3/` and `doc/man7/`
* Run `make install-docs` to install man pages on your system
* Full documentation in Asciidoc available in `doc/src/`

== Getting help

* Official IRC Channel: #ninenines on
*[Issues tracker]
*[Commercial Support]