Merge pull request #42 from bem/issue-36

Updated README files
bem · Oct 31, 2014 · 022f888 · 022f888
2 parents 1b44373 + 3dc2212
commit 022f888
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -248,6 +248,34 @@ myNaming.stringify({              // 'blockName-elemName--boolElemMod'
 });
 ```
 
+Convention by Harry Roberts
+---------------------------
+
+According to this convention elements are delimited with two underscores (__), and boolean modifiers are delimited by two hyphens (--).
+Key-value modifiers are not used.
+
+Read more in the [Guidelines](http://cssguidelin.es/#bem-like-naming).
+
+Example:
+
+```js
+var BEMNaming = bemNaming.BEMNaming;
+var csswizardry = new BEMNaming({
+    elem: '__',
+    mod: '--'
+});
+
+csswizardry.parse('block__elem'); // { block: 'block', elem: 'elem' }
+csswizardry.parse('block--mod');  // { block: 'block',
+                                  //   modName: 'mod', modVal: true }
+
+csswizardry.stringify({           // 'block__elem--mod'
+    block: 'block',
+    elem: 'elem',
+    modName: 'mod'
+});
+```
+
 License
 -------
 

diff --git a/README.ru.md b/README.ru.md
@@ -239,7 +239,7 @@ var myNaming = new BEMNaming({
                                   // элементов и модификаторов
 
 myNaming.parse('block--mod');     // { block: 'block',
-                                  //   modName: 'modFixed', modVal: true }
+                                  //   modName: 'mod', modVal: true }
 
 myNaming.stringify({              // 'blockName-elemName--boolElemMod'
     block: 'blockName',
@@ -248,6 +248,33 @@ myNaming.stringify({              // 'blockName-elemName--boolElemMod'
 });
 ```
 
+В стиле Гарри Робертса
+----------------------
+
+Согласно этому соглашению элементы отделяются от&nbsp;блока с&nbsp;помошью двух символов подчёркивания (__), а&nbsp;булевые модификаторы с&nbsp;помощью двух символов дефиса (--). Модификаторы вида ключ-значение не&nbsp;используются.
+
+Подробнее читайте в [руководстве](http://cssguidelin.es/#bem-like-naming).
+
+Пример:
+
+```js
+var BEMNaming = bemNaming.BEMNaming;
+var csswizardry = new BEMNaming({
+    elem: '__',
+    mod: '--'
+});
+
+csswizardry.parse('block__elem'); // { block: 'block', elem: 'elem' }
+csswizardry.parse('block--mod');  // { block: 'block',
+                                  //   modName: 'mod', modVal: true }
+
+csswizardry.stringify({           // 'block__elem--mod'
+    block: 'block',
+    elem: 'elem',
+    modName: 'mod'
+});
+```
+
 Лицензия
 --------