Clarify description in readme

[rauschma]

I’m not sure if I completely understand this text:

Verifies that installed modules comply with the requirements specified in package.json.

By default checks engine ranges, peer dependency ranges and installed versions and, in mono-repos using workspaces, by default checks all workspaces as well as the workspace root.

It may make sense to state requirements separately. Is this correct?

• What are the requirements? The version range specified in package.json > engines > node (details)

• Where are the requirements checked?

  • "peerDependencies"
  • "dependencies"
  • "devDependencies"
  • Monorepos via workspaces: all workspaces and workspace root

Questions:

• What exactly does “complying with the requirements” mean?
• Do the modules really have to be installed or could you also check package-lock.json?

[voxpelli]

Thanks for the feedback! Much appreciated to get an extra set of eyes in the text, especially from someone like you!

A better explanation of the checks can be found in the checks section, but also that can be improved: https://github.com/voxpelli/node-installed-check#checks

I guess the lock file could be used to check the engine and peer dependency checks – the third check, the original one, predates lock files and validates that the installed modules are valid according to the version ranges in package.json, something that a package manager can do against a lockfile when a lockfile is present

That third check is what made me create this module, as too many times I had debugged tests failing locally simply to realize I had pulled in changes from the remote without running npm install (because especially then that was really slow) and outdated dependencies was the source of the failing tests

[rauschma]

A better explanation of the checks can be found in the checks section

Helpful, thanks!