diff -r cdfa6479982b -r 3d8937fa93a8 client/README.md
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/client/README.md Wed Feb 05 17:46:38 2014 +0100
@@ -0,0 +1,124 @@
+# Renkan - Client configuration
+
+Renkan is a tool to simply build oriented graphs by creating nodes and drag'n'droping links,
+pictures and html elements from web pages. Each node can have title, description, uri/url, color,
+image and specific size. Each node can have title, uri/url and color.
+
+
+## Embedding Renkan in a web page
+
+Whatever configuration you have, you need to import those javascript files **in that order**...
+
+
+
+
+
+
+
+
+
+... and the renkan css file :
+
+
+
+Finally, add the div in you DOM :
+
+
+
+Your Renkan should be displayed. Now let's see more specifically the 2 displays possibilities : in body 100% or in a div with set width and height.
+
+N.B. : renkan.js is the concatenation of those js files : header.js main.js models.js defaults.js i18n.js paper-renderer.js full-json.js ldtjson-bin.js list-bin.js wikipedia-bin.js.
+
+### In body 100%
+
+Nothing to add, the html is very simple :
+
+
+
+
+
+
+### In a div
+
+The renkan div has the css attribute position:absolute, so the parent div has to be in position:relative. Here is a simple example including css and partial html :
+
+
+
+
+
+
+ This is a header
+
+
+
+
+
+
+
+
+## Embedding a read only Renkan
+
+To embed a read only Renkan, just add this script tag :
+
+
+
+
+
+## Embedding a writable Renkan
+
+### Simple mode : no bins on the left, just the canvas
+
+To embed a simple writable Renkan, just add this script tag. In the client folder, "data/simple-persist.php" makes a very simple persistent url.
+The persistent url is supposed to give the json data on GET request at page load, and save datas at PUT request sent by the browser :
+
+
+
+
+
+
+## Data bins
+
+More to come...
+
+
+
+
+