aboutsummaryrefslogtreecommitdiffstats
path: root/manual/toc.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2013-11-25 15:02:42 +0100
committerLoïc Hoguin <[email protected]>2013-11-25 15:02:42 +0100
commitd2318c0a286daf51b4fe8afc5c6a232eee71ca72 (patch)
tree30a4e2cfa6f6d63c9068145eb82e9ec77c48ec2b /manual/toc.md
parente4b3cf94ea41963fa0d65559e7ebb271bd96ba55 (diff)
downloadranch-d2318c0a286daf51b4fe8afc5c6a232eee71ca72.tar.gz
ranch-d2318c0a286daf51b4fe8afc5c6a232eee71ca72.tar.bz2
ranch-d2318c0a286daf51b4fe8afc5c6a232eee71ca72.zip
Add a manual
This is the manual for what is going to be in 1.0. It includes two things that are not in the code yet: the shutdown option and the accept_ack transport callback.
Diffstat (limited to 'manual/toc.md')
-rw-r--r--manual/toc.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/manual/toc.md b/manual/toc.md
new file mode 100644
index 0000000..af99d14
--- /dev/null
+++ b/manual/toc.md
@@ -0,0 +1,11 @@
+Ranch Function Reference
+========================
+
+The function reference documents the public interface of Ranch.
+
+ * [The Ranch Application](ranch_app.md)
+ * [ranch](ranch.md)
+ * [ranch_protocol](ranch_protocol.md)
+ * [ranch_ssl](ranch_ssl.md)
+ * [ranch_tcp](ranch_tcp.md)
+ * [ranch_transport](ranch_transport.md)