diff --git a/packages/config/README.md b/packages/config/README.md index 1c3b27fa..8322e9a0 100644 --- a/packages/config/README.md +++ b/packages/config/README.md @@ -2,6 +2,26 @@ ## Usage +Field | Type | Purpose +--- | --- | --- +root | Boolean | Used to determine the root directory from the current one +levels | Array | Contains list of known levels with their configurations +sets | Object> | +libs | Object | Libraries to use in sets +plugins | ? | ? + +### Level + +- `layer` +- `naming` - preset? +- `path` - optional. legacy path + +### Library + +- `path` - to library which should better contain their own `.bemrc` file with their own sets + +## API + ```js const bemConfig = require('@bem/sdk.config'); const optionalConfig = { plugins: { create: { techs: ['styl', 'browser.js'] } } };