From 63bc332565e9c595531df91a724d0493e8334050 Mon Sep 17 00:00:00 2001
From: andrewblond <andrewblond@yandex.com>
Date: Wed, 29 Oct 2014 17:44:03 +0300
Subject: [PATCH] Updated README files

---
 README.md    | 45 +++++++++++++++++++++++++++++++++++++++++++++
 README.ru.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 90 insertions(+)

diff --git a/README.md b/README.md
index 9d421a1b..f3d4ae36 100644
--- a/README.md
+++ b/README.md
@@ -52,6 +52,51 @@ BEM-entities can be defined with a help of js-object with the following fields:
 * `modName` — modifier's name.
 * `modVal` — modifier's value.
 
+The modifier consists of a pair of fields `modName` and `modVal`. This means that the field `modVal` without `modName` has no meaning.
+
+Example:
+
+```js
+// Modifier of block
+{
+    block: 'block',
+    modName: 'mod',
+    modVal: 'val'
+}
+
+// Not valid BEM-notation
+{
+    block: 'block',
+    modVal: 'val'
+}
+```
+
+To describe the boolean modifier (only the name, without a value) field `modVal` must be specified as `true`.
+
+Example:
+
+```js
+// Boolean modifier of block
+{
+    block: 'block',
+    modName: 'mod',
+    modVal: true
+}
+
+// Shorthand for the boolean modifier of block
+{
+    block: 'block',
+    modName: 'mod'
+}
+
+// Not valid BEM-notation
+{
+    block: 'block',
+    modName: 'mod',
+    modVal: false
+}
+```
+
 API
 ---
 
diff --git a/README.ru.md b/README.ru.md
index 2b308aba..4dbe1e75 100644
--- a/README.ru.md
+++ b/README.ru.md
@@ -52,6 +52,51 @@ bem-naming
 * `modName` — название модификатора.
 * `modVal` — значение модификатора.
 
+Модификатор состоит из пары `modName` и `modVal`. Это означает, что поле `modVal` без `modName` не имеет никакого смысла.
+
+Пример:
+
+```js
+// Модификатор блока
+{
+    block: 'block',
+    modName: 'mod',
+    modVal: 'val'
+}
+
+// Невалидная БЭМ-нотация
+{
+    block: 'block',
+    modVal: 'val'
+}
+```
+
+Чтобы задать булевый модификатор (только название, без значения) поле `modVal` должно быть указано со значением `true`.
+
+Пример:
+
+```js
+// Булевый модификатор блока
+{
+    block: 'block',
+    modName: 'mod',
+    modVal: true
+}
+
+// Сокращённая запись булевого модификатор блока
+{
+    block: 'block',
+    modName: 'mod'
+}
+
+// Невалидная БЭМ-нотация
+{
+    block: 'block',
+    modName: 'mod',
+    modVal: false
+}
+```
+
 API
 ---