uber-archive / npm-shrinkwrap

A consistent shrinkwrap tool
MIT License
774 stars 47 forks source link

wish: document differences between "npm shrinkwrap" and "npm-shrinkwrap" #70

Open markstos opened 9 years ago

markstos commented 9 years ago

It would be helpful if the docs contained a section to summarize the differences between "npm-shrinkwrap" and "npm shrinkwrap".

markstos commented 9 years ago

Confusingly, if you run man npm-shrinkwrap you'll get the docs for npm shrinkwrap, which makes it appear that the commands are the same, but npm-shrinkwrap --help documents options like sync which npm shrinkwrap does not have.

Raynos commented 9 years ago

The README has a motivation section documenting the things that npm-shrinkwrap works around.

MattiSG commented 8 years ago

And documenting the rationale for making this an external package rather than an NPM contribution would be interesting too ;)

markstos commented 8 years ago

Our experience has been that after upgrading to npm 3, we no longer needed npm-shrinkwrap and quit using it. npm shrinkwrap works well enough and supported is integrated into npm install, so commands like npm install --save also update the shrinkwrap file.