aboutsummaryrefslogtreecommitdiffstats
path: root/guide/toc.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2012-08-22 13:07:00 +0200
committerLoïc Hoguin <[email protected]>2012-08-22 13:17:24 +0200
commit85510e373fa6db2b6faca0ef0e7081cf99dba146 (patch)
treece558b6a8122a42a2f317c087299a1609f57db91 /guide/toc.md
parent9cafa5e675065993c117cd94cc903248f5c97991 (diff)
downloadranch-85510e373fa6db2b6faca0ef0e7081cf99dba146.tar.gz
ranch-85510e373fa6db2b6faca0ef0e7081cf99dba146.tar.bz2
ranch-85510e373fa6db2b6faca0ef0e7081cf99dba146.zip
Add initial Ranch guide
Diffstat (limited to 'guide/toc.md')
-rw-r--r--guide/toc.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/guide/toc.md b/guide/toc.md
new file mode 100644
index 0000000..87719df
--- /dev/null
+++ b/guide/toc.md
@@ -0,0 +1,28 @@
+Ranch User Guide
+================
+
+ * [Introduction](introduction.md)
+ * Purpose
+ * Prerequisites
+ * [Listeners](listeners.md)
+ * Purpose
+ * Starting and stopping
+ * Listening on a random port
+ * Listening on a port =< 1024
+ * Limiting the number of concurrent connections
+ * Upgrading
+ * [Transports](transports.md)
+ * Purpose
+ * TCP transport
+ * SSL transport
+ * Sending and receiving data
+ * Writing a transport handler
+ * [Protocols](protocols.md)
+ * Purpose
+ * Writing a protocol handler
+ * [Embedded mode](embedded.md)
+ * Purpose
+ * Embedding
+ * [Internals](internals.md)
+ * Architecture
+ * Efficiency considerations