summaryrefslogtreecommitdiffstats
path: root/docs/en/ranch/2.1/guide/introduction.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2021-09-09 12:15:32 +0200
committerLoïc Hoguin <[email protected]>2021-09-09 12:15:32 +0200
commit992831c7a516b5183c2af06260829d41aa45267c (patch)
tree4e874d3aa4fff73455fce70c5a184c171858d02f /docs/en/ranch/2.1/guide/introduction.asciidoc
parent48f39402181d959cad88cb3f460210c007169f50 (diff)
downloadninenines.eu-992831c7a516b5183c2af06260829d41aa45267c.tar.gz
ninenines.eu-992831c7a516b5183c2af06260829d41aa45267c.tar.bz2
ninenines.eu-992831c7a516b5183c2af06260829d41aa45267c.zip
Ranch 2.1.0
Diffstat (limited to 'docs/en/ranch/2.1/guide/introduction.asciidoc')
-rw-r--r--docs/en/ranch/2.1/guide/introduction.asciidoc25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/en/ranch/2.1/guide/introduction.asciidoc b/docs/en/ranch/2.1/guide/introduction.asciidoc
new file mode 100644
index 00000000..a682c46f
--- /dev/null
+++ b/docs/en/ranch/2.1/guide/introduction.asciidoc
@@ -0,0 +1,25 @@
+== 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, macOS and Windows.
+
+Ranch is developed for Erlang/OTP 22+.
+
+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]