Skip to content
This repository has been archived by the owner on Dec 11, 2019. It is now read-only.

Commit

Permalink
Update docs to call out NPM release to use; stating LTS rather than s…
Browse files Browse the repository at this point in the history 
…pecifying the version number

Auditors: @bridiver
  • Loading branch information
@bsclifton
bsclifton committed Nov 17, 2017
1 parent 39d7cb8 commit 74c4b38
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,11 @@ For other platforms (macOS, Linux) You'll need certain packages installed before

### Prerequisites

1. `nodejs` **`>= 7.9.0`**
1. the current LTS version of `nodejs`

Install from your package manager or download from https://nodejs.org
Install from your package manager, [nvm](https://github.com/creationix/nvm), or download from https://nodejs.org

2. [npm](https://github.com/npm/npm) version 5 or greater (to make use of the `package-lock.json`)

#### On Debian / Ubuntu /Mint

Expand Down

4 comments on commit 74c4b38

@bridiver
Copy link
Collaborator

Choose a reason for hiding this comment

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

++

@luixxiul
Copy link
Contributor

Choose a reason for hiding this comment

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

@bsclifton would you mind opening an issue to let us know why this change is required? 😄

@luixxiul
Copy link
Contributor

Choose a reason for hiding this comment

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

Also do we need to update here?

browser-laptop/package.json

Lines 233 to 235 in 573a95b

"engines": {
"node": ">= 7.9.0"
}

@bsclifton
Copy link
Member Author

@bsclifton bsclifton commented on 74c4b38 Nov 18, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

@luixxiul I think the reason is fairly self explanatory- by putting a version number in the documentation, it will always get out of date. Here are the current versions:
screen shot 2017-11-18 at 12 40 51 am

By saying "LTS", we no longer have to update the docs

For the item you highlighted in package.json... I'm not familiar with that. It would be great if we could provide an alias instead of having to hardcode a version

Please sign in to comment.