Skip to content

Commit

Permalink
Update install docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ismail-syed committed Nov 15, 2017
1 parent 0b2f8b3 commit 88919b8
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# prettier-stylelint [![NPM Version](https://img.shields.io/npm/v/prettier-stylelint.svg)](https://www.npmjs.com/package/prettier-stylelint) [![NPM Downloads](https://img.shields.io/npm/dt/prettier-stylelint.svg)](https://www.npmjs.com/package/prettier-stylelint) [![NPM License](https://img.shields.io/npm/l/prettier-stylelint.svg)](https://www.npmjs.com/package/prettier-stylelint) [![Build Status](https://travis-ci.org/hugomrdias/prettier-stylelint.svg?branch=master)](https://travis-ci.org/hugomrdias/prettier-stylelint) [![codecov](https://codecov.io/gh/hugomrdias/prettier-stylelint/branch/master/graph/badge.svg)](https://codecov.io/gh/hugomrdias/prettier-stylelint)
# prettier-stylelint-formatter [![NPM Version](https://img.shields.io/npm/v/prettier-stylelint-formatter.svg)](https://www.npmjs.com/package/prettier-stylelint-formatter)
> Format your styles with ease!
code > prettier > stylelint > formatted code
code > prettier > stylelint > formatted code

prettier-stylelint attempts to create a prettier config based on the stylelint config, then format with prettier followed by stylelint --fix. So after that you should end up with formatted code with no linting errors.

## Install

```bash
yarn add prettier-stylelint -D
npm install prettier-stylelint --save-dev
yarn add prettier-stylelint-formatter -D
npm install prettier-stylelint-formatter --save-dev
```

## Usage
Expand All @@ -30,7 +30,7 @@ This package has a stylelint config to disable some rules that conflict with pre

```

After adding the disabling config you can just `prettier-stylelint --write` and its done. Check the CLI options below for more information.
After adding the disabling config you can just `prettier-stylelint --write` and its done. Check the CLI options below for more information.
Also in a near future we should have support for prettier-stylelint in `prettier-vscode` follow this [PR](https://github.com/prettier/prettier-vscode/pull/218).


Expand All @@ -44,11 +44,11 @@ const options = {
const formatted = format(options)


// formatted
// formatted
a[id='foo'] {
content: 'x';
}
```
```

### CLI Options

Expand Down

0 comments on commit 88919b8

Please sign in to comment.