From 46c3b04ea8e282e24538b3cd3f8653b1aa8433ef Mon Sep 17 00:00:00 2001 From: Zoltan Kochan Date: Mon, 16 Jan 2017 20:51:12 +0200 Subject: [PATCH] docs(README): remove known issues section --- README.md | 16 ---------------- 1 file changed, 16 deletions(-) diff --git a/README.md b/README.md index 36e31118bd..3b0a68e285 100644 --- a/README.md +++ b/README.md @@ -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)