Skip to content
This repository has been archived by the owner on Feb 6, 2018. It is now read-only.

Commit

Permalink
Changed the description
Browse files Browse the repository at this point in the history
  • Loading branch information
godfreyd committed Aug 29, 2016
1 parent 2c6c0dd commit 2d47604
Showing 1 changed file with 15 additions and 11 deletions.
26 changes: 15 additions & 11 deletions README.ru.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# bem-walk

Инструмент позволяет обойти файловую систему БЭМ-проекта и получить следующую информацию о найденных файлах:

* тип БЭМ-сущности (Блок, Элемент, Модификатор);
* технология реализации;
* расположение на файловой системе.
Инструмент для обхода файловой системы БЭМ-проекта.

[![NPM Status][npm-img]][npm]
[![Travis Status][test-img]][travis]
Expand All @@ -27,6 +23,12 @@
[david]: https://david-dm.org/bem-sdk/bem-walk
[david-img]: http://img.shields.io/david/bem-sdk/bem-walk.svg?style=flat

Bem-walk позволяет получить следующую информацию о найденных файлах:

* тип БЭМ-сущности (Блок, Элемент, Модификатор);
* технология реализации;
* расположение на файловой системе.

## Быстрый старт

**Примечание** Для работы с `bem-walk` требуется установить Node.js 4.0+.
Expand All @@ -47,7 +49,7 @@ var walk = require('bem-walk');

### 3. Опишите уровни файловой системы

Опишите уровни файловой системы проекта в объекте `config`.
Опишите уровни файловой системы проекта в объекте `config`, созданного на шаге №2 файла.

```js
var config = {
Expand All @@ -67,10 +69,12 @@ var config = {

**Примечание** Для каждого уровня указывается схема именования файлов либо организации файловой системы. Это позволяет при обходе получать информацию о БЭМ-сущностях [по их именам](https://ru.bem.info/toolbox/sdk/bem-naming/#Строковое-представление) или по именам файлов и директорий.

| Схема | Значение по умолчанию | Все возможные значения |
|----------|-----|----------|
|`naming` — схема именования файлов.|`origin`| `origin`, `two-dashes`|
|`sheme` — cхема файловой системы.|`nested`|`nested`, `flat`|
Описание возможных значений, которые можно задать для каждой из схем, представлено в таблице.

| Ключ | Схема | Значение по умолчанию | Все возможные значения |
|----|------|-----|----------|
| `naming` | Именования файлов.|`origin`| `origin`, `two-dashes`|
| `scheme` | Файловой системы.|`nested`|`nested`, `flat`|

Подробнее:
* [bem-naming](https://ru.bem.info/toolbox/sdk/bem-naming/)
Expand Down Expand Up @@ -168,7 +172,7 @@ stream.on('end', () => console.log(files));

#### Входные параметры

Требования к поиску определяются параметрами `levels` и `config`. Параметры нельзя передавать в любой последовательности.
Требования к поиску определяются параметрами `levels` и `config`.

| Параметр | Тип | Описание |
|----------|-----|----------|
Expand Down

0 comments on commit 2d47604

Please sign in to comment.