mirror/pnpm
1
0
Fork 0
mirror of https://github.com/pnpm/pnpm.git synced 2026-05-18 22:02:53 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs(README): remove known issues section

Browse Source
This commit is contained in:
Zoltan Kochan
2017-01-16 20:51:12 +02:00
committed by GitHub
parent eb7c570143
commit 46c3b04ea8
1 changed files with 0 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -19,7 +19,6 @@ Follow the [pnpm Twitter account](https://twitter.com/pnpmjs) for updates.
* [Background](#background)
* [Install](#install)
* [Usage](#usage)
* [Known issues](#known-issues)
* [Benchmark](#benchmark)
* Recipes
* [Usage in monorepos](docs/recipes/usage-in-monorepos.md)
@@ -85,21 +84,6 @@ For using globally installed packages, see: [global install](docs/global-install
For using the programmatic API, see: [API](docs/api.md).
### Known issues
Some packages are trying to find and use other packages in `node_modules`.
However, when installed via pnpm, all the dependencies in `node_modules` are
just symlinks. Node's require ignores symlinks when resolving modules and this
causes a lot of issues. Luckily, starting from v6.3.0, Node.js has a CLI option to
preserve symlinks when resolving modules ([--preserve-symlinks](https://nodejs.org/api/cli.html#cli_preserve_symlinks)).
Things to remember:
* pnpm is best used on Node.js >= 6.3.0
* it is recommended to run Node with the `--preserve-symlinks` option. E.g. `node --preserve-symlinks index`. Note: it is important that `--preserve-symlinks` is at the beginning of the command, otherwise it is ignored.
* CLI apps installed with pnpm are configured to correctly work with symlinked dependency trees. If a global package is used to work with a pnpm package, the global package
should be installed via pnpm.
## Benchmark
pnpm is usually 10 times faster than npm and 30% faster than yarn. See [this](https://github.com/zkochan/node-package-manager-benchmark)