summaryrefslogtreecommitdiffstats
path: root/docs/en/ranch/1.4/guide/introduction.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2017-10-03 15:50:36 +0200
committerLoïc Hoguin <[email protected]>2017-10-03 15:50:36 +0200
commit5cb08c35580023b91091c93f9a1f9198e35055c2 (patch)
treefcac3159b52e14db41d5f1d1b19f5d8530cc0d74 /docs/en/ranch/1.4/guide/introduction.asciidoc
parent35bc482f0be143abd728a228e937984dc5f6cc73 (diff)
downloadninenines.eu-5cb08c35580023b91091c93f9a1f9198e35055c2.tar.gz
ninenines.eu-5cb08c35580023b91091c93f9a1f9198e35055c2.tar.bz2
ninenines.eu-5cb08c35580023b91091c93f9a1f9198e35055c2.zip
Fix some links and add Ranch 1.4 docs
They were mistakenly labeled as 1.3. Sorry!
Diffstat (limited to 'docs/en/ranch/1.4/guide/introduction.asciidoc')
-rw-r--r--docs/en/ranch/1.4/guide/introduction.asciidoc28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/en/ranch/1.4/guide/introduction.asciidoc b/docs/en/ranch/1.4/guide/introduction.asciidoc
new file mode 100644
index 00000000..ac27862e
--- /dev/null
+++ b/docs/en/ranch/1.4/guide/introduction.asciidoc
@@ -0,0 +1,28 @@
+== Introduction
+
+Ranch is a socket acceptor pool for TCP protocols.
+
+Ranch aims to provide everything you need to accept TCP connections
+with a small code base and low latency while being easy to use directly
+as an application or to embed into your own.
+
+=== Prerequisites
+
+It is assumed the developer already knows Erlang and has some experience
+with socket programming and TCP protocols.
+
+=== Supported platforms
+
+Ranch is tested and supported on Linux, FreeBSD, OSX and Windows.
+
+Ranch is developed for Erlang/OTP R16B+.
+
+There are known issues with the SSL application found in Erlang/OTP
+18.3.2 and 18.3.3. These versions are therefore not supported.
+
+Ranch may be compiled on earlier Erlang versions with small source code
+modifications but there is no guarantee that it will work as expected.
+
+=== Versioning
+
+Ranch uses http://semver.org/[Semantic Versioning 2.0.0]