docs(toc): add toc to readme

bem · Mar 25, 2016 · d0f86e2 · d0f86e2
1 parent adf8bc0
commit d0f86e2
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -37,6 +37,16 @@ bemNaming.parse('button__text'); // { block: 'button', elem: 'text' }
 bemNaming.stringify({ block: 'button', modName: 'checked' }); // button_checked
 ```
 
+Table of Contents
+-----------------
+
+* [String representation](#string-representation)
+* [Common misconceptions](#common-misconceptions)
+* [BEM-naming](#bem-naming-1)
+* [API](#api)
+* [Custom naming convention](#custom-naming-convention)
+* [Convention by Harry Roberts](#convention-by-harry-roberts)
+
 String representation
 ---------------------
 To define BEM entities we often use a special string format that allows us 100% define what entity exactly is represented.

diff --git a/README.ru.md b/README.ru.md
@@ -37,6 +37,16 @@ bemNaming.parse('button__text'); // { block: 'button', elem: 'text' }
 bemNaming.stringify({ block: 'button', modName: 'checked' }); // button_checked
 ```
 
+Оглавление
+----------
+
+* [Строковое представление](#Строковое-представление)
+* [Частые заблуждения](#Частые-заблуждения)
+* [БЭМ-нотация](#БЭМ-нотация)
+* [API](#api)
+* [Собственный стиль](#Собственный-стиль)
+* [В стиле Гарри Робертса](#В-стиле-Гарри-Робертса)
+
 Строковое представление
 -----------------------
 Для обозначения БЭМ-сущностей зачастую используется специальный формат строки, по которой можно однозначно определить, какая именно сущность представлена.