From decd8dbdc50c41be2c3394019ece146e4ccfb507 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Samy=20Pess=C3=A9?= <samypesse@gmail.com>
Date: Mon, 26 Jan 2015 10:32:19 +0100
Subject: [PATCH] Add infos in readme about variables and templating

---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)

diff --git a/README.md b/README.md
index 9b600ccd2..04c77e176 100644
--- a/README.md
+++ b/README.md
@@ -113,6 +113,40 @@ With it's definition, this can contain bold text and all other kinds of inline m
 
 #### Variables and Templating
 
+A set of variables can be defined in the `book.json`:
+
+```js
+{
+    "variables": {
+        "host": "mybook.com"
+    }
+}
+```
+
+These variables can be used in the markdown files:
+
+```
+The host is {{ book.host }}
+```
+
+You can also use condition with these variables:
+
+```
+{% if book.host == "mybook.com" %}
+
+{% else %}
+
+{% endif %}
+```
+
+Variables of `book.json` are available in the `book` namespace. You can also access informations about the `file` itself and the `gitbook` version:
+
+```
+My file is {{ file.path }}
+Modified at {{ file.mtime }}
+Book built with GitBook {{ gitbook.version }}
+```
+
 #### Content References
 
 You can use "content references," or conrefs, when writing books or documentation using GitBook.