aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2012-11-13 17:58:24 +0100
committerLoïc Hoguin <[email protected]>2012-11-13 17:58:33 +0100
commitfd4b7f92473c677d57879cbda73622948ac474fc (patch)
tree0130820557837dac26d93e5f55219c86e4bb1bc7 /README.md
parent3959167adb87517591e81dc609db18a0da07823e (diff)
downloadranch-fd4b7f92473c677d57879cbda73622948ac474fc.tar.gz
ranch-fd4b7f92473c677d57879cbda73622948ac474fc.tar.bz2
ranch-fd4b7f92473c677d57879cbda73622948ac474fc.zip
Better markdown in the README
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/README.md b/README.md
index d6b049a..7e3b736 100644
--- a/README.md
+++ b/README.md
@@ -28,13 +28,13 @@ duplicating efforts.
Quick start
-----------
-* Add Ranch as a rebar dependency to your application.
-* Start Ranch and add one or more listeners.
-* Write protocol handlers for your application.
+ * Add Ranch as a rebar dependency to your application
+ * Start Ranch and add one or more listeners
+ * Write protocol handlers for your application
Getting started
---------------
-* [Read the guide](https://github.com/extend/ranch/blob/master/guide/toc.md)
-* Look at the examples in the ```examples/``` directory
-* Build API documentation with ```make docs```; open ```doc/index.html```
+ * [Read the guide](http://ninenines.eu/docs/en/ranch/HEAD/guide/introduction)
+ * Look at the examples in the `examples/` directory
+ * Build API documentation with `make docs`; open `doc/index.html`