From cf2d06c2881a28173a2e9f1f65e3277c9fea38f9 Mon Sep 17 00:00:00 2001 From: Alan Shaw Date: Tue, 19 Feb 2019 14:34:16 +0000 Subject: [PATCH 1/2] docs: note about required build tools for node-gyp resolves #1790 --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b7c7a81adc..57bec03efa 100644 --- a/README.md +++ b/README.md @@ -86,15 +86,17 @@ You can check the development status at the [Kanban Board](https://waffle.io/ipf ### npm -This project is available through [npm](https://www.npmjs.com/). To install run +This project is available through [npm](https://www.npmjs.com/). To install, run: ```bash > npm install ipfs ``` +JS IPFS depends on native modules that are installed by [`node-gyp`](https://github.com/nodejs/node-gyp). If you have problems running the command above, it is likely that the [build tools required by `node-gyp`](https://github.com/nodejs/node-gyp#installation) are missing from your system. Please install them and then try again. + We support both the Current and Active LTS versions of Node.js. Please see [nodejs.org](https://nodejs.org/) for what these currently are. -This project is tested on OSX & Linux, expected to work on Windows. +This project is tested on macOS & Linux and Windows. ### Use in Node.js From 9b89cb1caea67fa2063169bc53c08509e48ca719 Mon Sep 17 00:00:00 2001 From: Alan Shaw Date: Tue, 19 Feb 2019 14:35:12 +0000 Subject: [PATCH 2/2] refactor: too many and --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 57bec03efa..931f47a420 100644 --- a/README.md +++ b/README.md @@ -96,7 +96,7 @@ JS IPFS depends on native modules that are installed by [`node-gyp`](https://git We support both the Current and Active LTS versions of Node.js. Please see [nodejs.org](https://nodejs.org/) for what these currently are. -This project is tested on macOS & Linux and Windows. +This project is tested on macOS, Linux and Windows. ### Use in Node.js