aboutsummaryrefslogtreecommitdiffstats
path: root/guide/toc.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2013-11-15 22:00:05 +0100
committerLoïc Hoguin <[email protected]>2013-11-15 22:00:05 +0100
commit33e1b4fcb0954f61588cb1baff905d107f74b467 (patch)
tree0fbd6c334179c9f1d76d0d9225aae6ee108f2e73 /guide/toc.md
parentcbf00a11298e9a19e1931c649142b069f27798b9 (diff)
downloadranch-33e1b4fcb0954f61588cb1baff905d107f74b467.tar.gz
ranch-33e1b4fcb0954f61588cb1baff905d107f74b467.tar.bz2
ranch-33e1b4fcb0954f61588cb1baff905d107f74b467.zip
Small refresh of the guide toc
Diffstat (limited to 'guide/toc.md')
-rw-r--r--guide/toc.md41
1 files changed, 14 insertions, 27 deletions
diff --git a/guide/toc.md b/guide/toc.md
index eac5338..6caa145 100644
--- a/guide/toc.md
+++ b/guide/toc.md
@@ -1,37 +1,24 @@
Ranch User Guide
================
+The Ranch User Guide explores how to make best use of Ranch
+for writing powerful TCP applications.
+
+Introducing Ranch
+-----------------
+
* [Introduction](introduction.md)
- * Purpose
- * Prerequisites
+
+Using Ranch
+-----------
+
* [Listeners](listeners.md)
- * Purpose
- * Starting and stopping
- * Default transport options
- * Listening on a random port
- * Listening on privileged ports
- * Accepting connections on an existing socket
- * 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
- * Using gen_server
+
+Advanced topics
+---------------
+
* [SSL client authentication](ssl_auth.md)
- * Purpose
- * Obtaining client certificates
- * Transport configuration
- * Authentication
* [Embedded mode](embedded.md)
- * Purpose
- * Embedding
* [Internals](internals.md)
- * Architecture
- * Number of acceptors
- * Platform-specific TCP features