# HG changeset patch
# User rougeronj
# Date 1442419000 -7200
# Node ID e5d023194681581936ff1c91007f4403981f36e6
# Parent  2336eb7ca9cec157ff4eb3d858b86633c29fb1ce
update the README and add a new section "Url Parameters"

diff -r 2336eb7ca9ce -r e5d023194681 client/README.md
--- a/client/README.md	Wed Sep 16 17:55:35 2015 +0200
+++ b/client/README.md	Wed Sep 16 17:56:40 2015 +0200
@@ -302,6 +302,14 @@
 </script>
 ```
 
+## Url Parameters
+
+Renkan accepts few Hash parameters allowing you to change the view, navigate in the map, highlight some nodes, etc. (e.g: http://myrenkan.com/renkan1/#?viewIndex=2&idNode=12345)
+Here is an exhaustive list of these parameters:
+* viewIndex=index: init the renkan with the indexed view. Negative index starts from the end of the list of views (viewIndex=-1 will load the last view). In case the view doesn't exist, the initial view (viewIndex=0) will be loaded.
+* view=offset-x,offset-y,zoom-level: Load a view with the given zoom and offset parameters
+* idNode=id: highlight a node according to the given node id. 
+
 ## Drop management
 
 You can override, partially or totally, the function that handle the drop event from an other web page.