Skip to content
This repository was archived by the owner on Feb 12, 2024. It is now read-only.

Commit d55f632

Browse files
author
Alan Shaw
authored
docs: note about required build tools for node-gyp (#1888)
1 parent c60de74 commit d55f632

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,15 +86,17 @@ You can check the development status at the [Kanban Board](https://waffle.io/ipf
8686

8787
### npm
8888

89-
This project is available through [npm](https://www.npmjs.com/). To install run
89+
This project is available through [npm](https://www.npmjs.com/). To install, run:
9090

9191
```bash
9292
> npm install ipfs
9393
```
9494

95+
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.
96+
9597
We support both the Current and Active LTS versions of Node.js. Please see [nodejs.org](https://nodejs.org/) for what these currently are.
9698

97-
This project is tested on OSX & Linux, expected to work on Windows.
99+
This project is tested on macOS, Linux and Windows.
98100

99101
### Use in Node.js
100102

0 commit comments

Comments
 (0)