diff options
author | Loïc Hoguin <[email protected]> | 2012-08-22 13:07:00 +0200 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2012-08-22 13:17:24 +0200 |
commit | 85510e373fa6db2b6faca0ef0e7081cf99dba146 (patch) | |
tree | ce558b6a8122a42a2f317c087299a1609f57db91 /guide/introduction.md | |
parent | 9cafa5e675065993c117cd94cc903248f5c97991 (diff) | |
download | ranch-85510e373fa6db2b6faca0ef0e7081cf99dba146.tar.gz ranch-85510e373fa6db2b6faca0ef0e7081cf99dba146.tar.bz2 ranch-85510e373fa6db2b6faca0ef0e7081cf99dba146.zip |
Add initial Ranch guide
Diffstat (limited to 'guide/introduction.md')
-rw-r--r-- | guide/introduction.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/guide/introduction.md b/guide/introduction.md new file mode 100644 index 0000000..c63eaef --- /dev/null +++ b/guide/introduction.md @@ -0,0 +1,25 @@ +Introduction +============ + +Purpose +------- + +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. + +In order to run the examples available in this user guide, you will need +Erlang and rebar installed and in your $PATH. + +Please see the [rebar repository](https://github.com/basho/rebar) for +downloading and building instructions. Please look up the environment +variables documentation of your system for details on how to update the +$PATH information. |