summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSamy Pessé <samypesse@gmail.com>2016-12-22 11:04:41 +0100
committerSamy Pessé <samypesse@gmail.com>2016-12-22 11:04:41 +0100
commit43ce7badb7669f30e2a030d1575e2c899ce0222f (patch)
treedd268d97b21084f9cecff3c9acd71c59c201c574
parent9e399da06a86483e298a69e5e9af41b906bc36d3 (diff)
downloadgitbook-43ce7badb7669f30e2a030d1575e2c899ce0222f.zip
gitbook-43ce7badb7669f30e2a030d1575e2c899ce0222f.tar.gz
gitbook-43ce7badb7669f30e2a030d1575e2c899ce0222f.tar.bz2
Change instruction in readme to mention "yarn"
-rw-r--r--CONTRIBUTING.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d8c3fb0..07fe8e3 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -32,20 +32,20 @@ Please include tests and docs with every pull request!
## Running Tests
-To run the examples, you need to have the GitBook repository cloned to your computer. After that, you need to `cd` into the directory where you cloned it, and install the dependencies from `npm`.
+To run the examples, you need to have the GitBook repository cloned to your computer. After that, you need to `cd` into the directory where you cloned it, and install the dependencies from `npm` using `yarn`.
```
-npm install
+$ yarn install
```
Then you'll need to bootstrap it:
```
-npm run bootstrap
+$ npm run bootstrap
```
Which will also compile the source files. Then run the tests with:
```
-npm test
+$ npm test
```