aboutsummaryrefslogtreecommitdiffstats
path: root/manual/gun_app.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2013-08-27 14:50:36 +0200
committerLoïc Hoguin <[email protected]>2013-08-27 14:50:36 +0200
commitd9a37f7398deb10fb4493b20644f721e0e9fa953 (patch)
tree43e1586de17a7ca59c2dab4fb932161f555f494c /manual/gun_app.md
parented2c689592d6a7f4b4a8f0ed05648effeff832ac (diff)
downloadgun-d9a37f7398deb10fb4493b20644f721e0e9fa953.tar.gz
gun-d9a37f7398deb10fb4493b20644f721e0e9fa953.tar.bz2
gun-d9a37f7398deb10fb4493b20644f721e0e9fa953.zip
Add a manual
Diffstat (limited to 'manual/gun_app.md')
-rw-r--r--manual/gun_app.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/manual/gun_app.md b/manual/gun_app.md
new file mode 100644
index 0000000..448145b
--- /dev/null
+++ b/manual/gun_app.md
@@ -0,0 +1,22 @@
+The Gun Application
+===================
+
+Asynchronous SPDY, HTTP and Websocket client.
+
+Dependencies
+------------
+
+The `gun` application uses the Erlang applications `ranch`
+for abstracting TCP and SSL over a common interface, and
+the applications `asn1`, `public_key` and `ssl` for using
+the SSL transport. These dependencies must be loaded for
+the `gun` application to work. In an embedded environment
+this means that they need to be started with the
+`application:start/{1,2}` function before the `gun`
+application is started.
+
+Environment
+-----------
+
+The `gun` application does not define any application
+environment configuration parameters.