summaryrefslogtreecommitdiffstats
path: root/docs/en/ranch/1.8/guide/introduction.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2021-05-12 11:13:47 +0200
committerLoïc Hoguin <[email protected]>2021-05-12 11:13:47 +0200
commit48f39402181d959cad88cb3f460210c007169f50 (patch)
treeee45d02b0683fd88f725fb43c75bdf171cb51568 /docs/en/ranch/1.8/guide/introduction.asciidoc
parent338611332e05e2a35a70f11edd36b050843bcee8 (diff)
downloadninenines.eu-48f39402181d959cad88cb3f460210c007169f50.tar.gz
ninenines.eu-48f39402181d959cad88cb3f460210c007169f50.tar.bz2
ninenines.eu-48f39402181d959cad88cb3f460210c007169f50.zip
Cowboy 2.9.0
Diffstat (limited to 'docs/en/ranch/1.8/guide/introduction.asciidoc')
-rw-r--r--docs/en/ranch/1.8/guide/introduction.asciidoc25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/en/ranch/1.8/guide/introduction.asciidoc b/docs/en/ranch/1.8/guide/introduction.asciidoc
new file mode 100644
index 00000000..16449217
--- /dev/null
+++ b/docs/en/ranch/1.8/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, OSX and Windows.
+
+Ranch is developed for Erlang/OTP 19+.
+
+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]