summaryrefslogtreecommitdiffstats
path: root/docs/en/ranch/1.6/guide/introduction.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2018-08-01 16:52:33 +0200
committerLoïc Hoguin <[email protected]>2018-08-01 16:52:33 +0200
commita63ee9b363aa7214343966690b50d77f4d3475e6 (patch)
tree3172bf0b364d9c3d76cfe5bed15154254460ba53 /docs/en/ranch/1.6/guide/introduction.asciidoc
parent34bea68bc8c23429ab788387b4db110135789adf (diff)
downloadninenines.eu-a63ee9b363aa7214343966690b50d77f4d3475e6.tar.gz
ninenines.eu-a63ee9b363aa7214343966690b50d77f4d3475e6.tar.bz2
ninenines.eu-a63ee9b363aa7214343966690b50d77f4d3475e6.zip
Ranch 1.6.0
Diffstat (limited to 'docs/en/ranch/1.6/guide/introduction.asciidoc')
-rw-r--r--docs/en/ranch/1.6/guide/introduction.asciidoc28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/en/ranch/1.6/guide/introduction.asciidoc b/docs/en/ranch/1.6/guide/introduction.asciidoc
new file mode 100644
index 00000000..301df21e
--- /dev/null
+++ b/docs/en/ranch/1.6/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 18+.
+
+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]