Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor wording for linking. #24

Merged
merged 3 commits into from
Jan 23, 2024
Merged

Refactor wording for linking. #24

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3148765
Refactor wording for linking.
enjikaka Jan 23, 2024
0cb7e78
Merge branch 'main' into player/readme-milder
enjikaka Jan 23, 2024
0925f62
Add a
enjikaka Jan 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions packages/player/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 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)
Expand Down