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

docs: note about required build tools for node-gyp #1888

Merged
merged 2 commits into from
Feb 20, 2019
Merged

docs: note about required build tools for node-gyp #1888

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cf2d06c
docs: note about required build tools for node-gyp
Feb 19, 2019
9b89cb1
refactor: too many and
Feb 19, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make sure to announce full support on the twittersphere as well :D

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We've been testing on Windows for a long time...that's why I updated - no big change or anything!


### Use in Node.js

Expand Down