Skip to content

Commit 98747c6

Browse files
committed
fix(use): describe how to use in README
1 parent 52661ca commit 98747c6

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,29 @@
22

33
> Rebuilds node-sass but only if needed
44
5+
[![NPM][npm-icon] ][npm-url]
6+
57
[![Build status][ci-image] ][ci-url]
68
[![semantic-release][semantic-image] ][semantic-url]
79

10+
## Use
11+
12+
```sh
13+
npm install --save-dev rebuild-node-sass node-sass
14+
```
15+
16+
Then before build (when `node-sass` is probably used), call `rebuild-node-sass`
17+
to make sure it is ready
18+
19+
```json
20+
{
21+
"scripts": {
22+
"prebuild": "rebuild-node-sass",
23+
"build": "..."
24+
}
25+
}
26+
```
27+
828
## Testing
929

1030
To execute in a different environment, for example when working on Mac, we
@@ -31,6 +51,8 @@ Binary is fine
3151
node-sass@4.5.3 /src/node_modules/node-sass
3252
```
3353
54+
[npm-icon]: https://nodei.co/npm/rebuild-node-sass.svg?downloads=true
55+
[npm-url]: https://npmjs.org/package/rebuild-node-sass
3456
[ci-image]: https://travis-ci.org/bahmutov/rebuild-node-sass.svg?branch=master
3557
[ci-url]: https://travis-ci.org/bahmutov/rebuild-node-sass
3658
[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg

0 commit comments

Comments
 (0)