diff --git a/README.md b/README.md index 4cc9ceb..785e1b4 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,6 @@ [![npm version][npm-img]][npm-url] [![npm downloads][npm-dls]][npm-url] [![dependency status][david-img]][david-url] -[![build status][travis-img]][travis-url] [![github issues][issues-img]][issues-url] A [Stylelint][] config that sorts CSS properties the way [Recess][] did and @@ -13,17 +12,17 @@ Bootstrap [did][]/[does][]. ## Usage -1. Add [stylelint][] and this package to your project: +1. Add [stylelint][] and this package to your project: ```sh npm install --save-dev stylelint stylelint-config-recess-order ``` -2. Configure your stylelint configuration file to extend this package: +2. Configure your stylelint configuration file to extend this package: ```js - { - "extends": "stylelint-config-recess-order", - "rules": { - // Add overrides and additional rules here - } + module.exports = { + extends: ['stylelint-config-recess-order'], + rules: { + // Add overrides and additional rules here + }, } ``` @@ -32,29 +31,14 @@ Bootstrap [did][]/[does][]. [@mdo on CSS Property Order][mdo-order] [npm-url]: https://www.npmjs.com/package/stylelint-config-recess-order - [npm-img]: https://img.shields.io/npm/v/stylelint-config-recess-order.svg?style=flat-square - [npm-dls]: https://img.shields.io/npm/dt/stylelint-config-recess-order.svg?style=flat-square - [david-url]: https://david-dm.org/stormwarning/stylelint-config-recess-order - [david-img]: https://img.shields.io/david/stormwarning/stylelint-config-recess-order.svg?style=flat-square - -[travis-url]: https://travis-ci.org/stormwarning/stylelint-config-recess-order - -[travis-img]: https://img.shields.io/travis/stormwarning/stylelint-config-recess-order.svg?style=flat-square - [issues-url]: https://github.com/stormwarning/stylelint-config-recess-order/issues - [issues-img]: https://img.shields.io/github/issues/stormwarning/stylelint-config-recess-order.svg?style=flat-square - [stylelint]: https://github.com/stylelint/stylelint - [recess]: https://github.com/twitter/recess/blob/29bccc870b7b4ccaa0a138e504caf608a6606b59/lib/lint/strict-property-order.js - [did]: https://github.com/twbs/bootstrap/blob/f58997a0dae54dc98d11892afef9acb85bdc6a1e/.scss-lint.yml#L136 - [does]: https://github.com/twbs/bootstrap/blob/ba878eb542ab6c04786741569ba089d02e9bea46/.stylelintrc#L36 - [mdo-order]: http://markdotto.com/2011/11/29/css-property-order/