Merge pull request #10 from fulldump/feature/document-routing-example

Extend doc with routing diagram
fulldump · Feb 17, 2016 · 74e5498 · 74e5498
2 parents 2ac3273 + 81e295b
commit 74e5498
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -12,6 +12,7 @@ Golax is the official go implementation for the _Lax_ framework.
 
 - [About Lax](#about-lax)
 - [Getting started](#getting-started)
+- [Routing example](#routing-example)
 - [Performance](#performance)
 - [How interceptor works](#how-interceptor-works)
 - [Handling parameters](#handling-parameters)
@@ -53,6 +54,20 @@ my_api.Root.Node("hello").
 my_api.Serve()
 ```
 
+## Routing example
+
+Routing is based on nodes.
+
+<p align="center">
+    <img src="doc/figure_4_routing_example.png">
+</p>
+
+There are three types: `static`, `regex` and `parameter`.
+
+* static: Only matches with the url part if it is exactly the same.
+* regex: Surrounded by `(` and `)`, if the regex match.
+* parameter: Surrounded by `{` and `}`, always matches.
+
 ## Performance
 
 The performance compared with the [most popular alternative](http://www.gorillatoolkit.org/) is very similar (actually _golax_ performs slightly better) however code readability and maintainability is far better with _golax_ implementation.

diff --git a/doc/figure_4_routing_example.png b/doc/figure_4_routing_example.png