From 1fe08336625b1a075381348b743b501e540afff7 Mon Sep 17 00:00:00 2001 From: Mateusz Zatorski Date: Wed, 11 Jan 2017 16:30:46 +0000 Subject: [PATCH] add yarn.lock and tests to .npmignore and add yarn instructions to README --- .npmignore | 3 +++ README.md | 16 +++++++++++++--- 2 files changed, 16 insertions(+), 3 deletions(-) create mode 100644 .npmignore diff --git a/.npmignore b/.npmignore new file mode 100644 index 00000000..8cbdff7f --- /dev/null +++ b/.npmignore @@ -0,0 +1,3 @@ +yarn.lock +tests +tests_config diff --git a/README.md b/README.md index 8ee5e736..5b470ac9 100644 --- a/README.md +++ b/README.md @@ -86,10 +86,20 @@ into account, wrapping code when necessary. Install: ``` -npm install [-g] prettier +yarn add prettier ``` -You can install it globally if you like. +You can install it globally if you like: + +``` +yarn global add prettier +``` + +*We're defaulting to `yarn` but you can use `npm` if you like: + +``` +npm install [-g] prettier +``` ### CLI @@ -188,7 +198,7 @@ Better docs will come soon. We will work on better docs over time, but in the mean time, here are a few notes if you are interested in contributing: -* You should be able to get up and running with just `npm install` +* You should be able to get up and running with just `yarn` * This uses jest snapshots for tests. The entire Flow test suite is included here and you can make changes and run `jest -u` and then `git diff` to see the styles that changed. Always update the