Skip to content

Commit 5111759

Browse files
author
blond
committed
docs(usage): add info about usage
1 parent 5b7b897 commit 5111759

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,17 @@ About
1919

2020
This tool allows getting information about BEM entity using [string](#string-representation) as well as forming string representation based on [BEM-naming](#bem-naming).
2121

22+
Usage
23+
-----
24+
25+
```js
26+
var bemNaming = require('bem-naming');
27+
28+
bemNaming.parse('button__text'); // { block: 'button', elem: 'text' }
29+
30+
bemNaming.stringify({ block: 'button', modName: 'checked' }); // button_checked
31+
```
32+
2233
String representation
2334
---------------------
2435
To define BEM entities we often use a special string format that allows us 100% define what entity exactly is represented.

README.ru.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,17 @@ bem-naming
1919

2020
Инструмент позволяет получать информацию о БЭМ-сущности по [строке](#%D0%A1%D1%82%D1%80%D0%BE%D0%BA%D0%BE%D0%B2%D0%BE%D0%B5-%D0%BF%D1%80%D0%B5%D0%B4%D1%81%D1%82%D0%B0%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5), а так же формировать строковое представление на основе [БЭМ-нотации](#%D0%91%D0%AD%D0%9C-%D0%BD%D0%BE%D1%82%D0%B0%D1%86%D0%B8%D1%8F).
2121

22+
Быстрый старт
23+
-------------
24+
25+
```js
26+
var bemNaming = require('bem-naming');
27+
28+
bemNaming.parse('button__text'); // { block: 'button', elem: 'text' }
29+
30+
bemNaming.stringify({ block: 'button', modName: 'checked' }); // button_checked
31+
```
32+
2233
Строковое представление
2334
-----------------------
2435
Для обозначения БЭМ-сущностей зачастую используется специальный формат строки, по которой можно однозначно определить, какая именно сущность представлена.

0 commit comments

Comments
 (0)