Merge pull request #43 from joshwcomeau/fix-tests

Launch prep
joshwcomeau · Jul 12, 2018 · 2e25fba · 2e25fba
2 parents 130f1a4 + 572bcf3
commit 2e25fba
Show file tree

Hide file tree

Showing 12 changed files with 19,939 additions and 251 deletions.
diff --git a/.flowconfig b/.flowconfig
@@ -1,4 +1,5 @@
 [ignore]
+.*/node_modules/electron-packager/test/fixtures/infer-malformed-json/package.json
 
 [include]
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -44,7 +44,7 @@ npm run package
 
 The result will be in the `release-builds` folder.
 
-### Testing and Linting
+### Testing and Type-Checking
 
 Unfortunately, very little of Guppy is currently tested.
 
@@ -54,6 +54,12 @@ We hope to add more tests in the meantime, as well as add CI integration to run
 npm run test
 ```
 
+This project uses Flow, and the types can be checked with:
+
+```
+npm run flow
+```
+
 This project uses Prettier, this should be run automatically on commit.
 
 ### Docs

diff --git a/README.md b/README.md
@@ -41,7 +41,7 @@ Want to help build Guppy? This is the biggest missing feature right now, and con
 
 ### Installation
 
-To use Guppy, you'll first need to have a modern version of Node (a Javascript runtime) installed. [Download Node](https://nodejs.org/en/download/current/).
+To use Guppy, you'll first need to have a modern version of Node (a Javascript runtime) installed. [Download Node](https://nodejs.org/en/download/current/). The "Current" version is recommended over LTS due to a bug in NPM 5.6.0 that can corrupt dependencies.
 
 Once Node is installed, you can [download Guppy]() (TODO: Add link).
 

diff --git a/TODO.md b/TODO.md