From 3148765fbd64fa4814b59b7d19a944af3e9e164d Mon Sep 17 00:00:00 2001 From: Jeremy Karlsson Date: Tue, 23 Jan 2024 13:09:46 +0100 Subject: [PATCH 1/2] Refactor wording for linking. --- packages/player/README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/packages/player/README.md b/packages/player/README.md index 987470d7..dc920705 100644 --- a/packages/player/README.md +++ b/packages/player/README.md @@ -28,9 +28,7 @@ Building is done with Vite. ### Linking -To load TIDAL Player into project locally without publishing to npm; DO NOT use `pnpm link`, `yarn link` or `npm link`. These are _bad tools_ which _DO NOT WORK_. - -Manually configure a "hard link" using the `file:` protocol in package.json of the destination project like so: +To load TIDAL Player into project locally without publishing to npm; using `pnpm link`, `yarn link` or `npm link` can be problematic, especially if your project does not also use pnpm like this repo does. If so, you need to manually configure a "hard link" using the `file:` protocol in package.json of the destination project like so: 1. Open the package.json in the project. (in the case of webclient, the root one) 2. Add or edit a `"resolutions"` property on the top level. (this is an object) From 0925f6272fc6d8ad206b44a67b70f6cac7033e59 Mon Sep 17 00:00:00 2001 From: Jeremy Karlsson Date: Tue, 23 Jan 2024 13:14:17 +0100 Subject: [PATCH 2/2] Add a --- packages/player/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/player/README.md b/packages/player/README.md index dc920705..658c1fe0 100644 --- a/packages/player/README.md +++ b/packages/player/README.md @@ -28,7 +28,7 @@ Building is done with Vite. ### Linking -To load TIDAL Player into project locally without publishing to npm; using `pnpm link`, `yarn link` or `npm link` can be problematic, especially if your project does not also use pnpm like this repo does. If so, you need to manually configure a "hard link" using the `file:` protocol in package.json of the destination project like so: +To load TIDAL Player into a project locally without publishing to npm; using `pnpm link`, `yarn link` or `npm link` can be problematic, especially if your project does not also use pnpm like this repo does. If so, you need to manually configure a "hard link" using the `file:` protocol in package.json of the destination project like so: 1. Open the package.json in the project. (in the case of webclient, the root one) 2. Add or edit a `"resolutions"` property on the top level. (this is an object)