Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(readme): NodeJS version support info #1986

Merged
merged 2 commits into from
Jul 24, 2022
Merged
Changes from 1 commit
Commits
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
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,15 @@ With a supported Node.js version: [![](https://byob.yarr.is/ipfs/ipfs-webui/node
> npm install
```

#### A Note on NodeJS support
We will only support *even numbered* nodejs versions that are classified in one of the following release statuses:

* Current (Support = P1)
* Active LTS (Support = P0)
* Maintenance LTS (Support = P2)

See https://nodejs.org/en/about/releases/ for more information about which versions have which release statuses.

lidel marked this conversation as resolved.
Show resolved Hide resolved
## Usage

**When working on the code**, run an ipfs daemon, the local [dev server](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#npm-start), the [unit tests](https://facebook.github.io/jest/), and the [storybook](https://storybook.js.org/) component viewer and see the results of your changes as you save files.
Expand Down