diff options
| author | Loïc Hoguin <[email protected]> | 2015-08-22 13:15:08 +0200 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2015-08-22 13:15:08 +0200 |
| commit | f4c6da56d4fe9494f4fe23c48b8d7c3c1e9e6b42 (patch) | |
| tree | 5f73255bbd51d46fccf371ff7cdd67c6bea8e7b7 /doc/src/guide/introduction.asciidoc | |
| parent | d30408b2e8c14c0e56ce997f5aff0010c03cef0b (diff) | |
| download | ranch-f4c6da56d4fe9494f4fe23c48b8d7c3c1e9e6b42.tar.gz ranch-f4c6da56d4fe9494f4fe23c48b8d7c3c1e9e6b42.tar.bz2 ranch-f4c6da56d4fe9494f4fe23c48b8d7c3c1e9e6b42.zip | |
Convert the documentation to Asciidoc
Diffstat (limited to 'doc/src/guide/introduction.asciidoc')
| -rw-r--r-- | doc/src/guide/introduction.asciidoc | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/src/guide/introduction.asciidoc b/doc/src/guide/introduction.asciidoc new file mode 100644 index 0000000..3199fb2 --- /dev/null +++ b/doc/src/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. + +Ranch is developed for Erlang R15B01+. + +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] |