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.

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

README recommends not installing it directly to projects #46

Open
guillempuche opened this issue Sep 9, 2024 · 3 comments
Open

README recommends not installing it directly to projects #46

guillempuche opened this issue Sep 9, 2024 · 3 comments

Comments

@guillempuche
Copy link

@powersync/react-native recommends installing this package https://github.com/powersync-ja/powersync-js/tree/main/packages/react-native#install-peer-dependency-sqlite

Which guide do we follow?

@guillempuche guillempuche changed the title README recommends to not install it directly to projects README recommends not installinng it directly to projects Sep 9, 2024
@guillempuche guillempuche changed the title README recommends not installinng it directly to projects README recommends not installing it directly to projects Sep 9, 2024
@stevensJourney
Copy link
Collaborator

I believe the intention of the message on this package's readme is for developers not to use this package if not using the PowerSync SDK.

This fork contains PowerSync specific SQLite extension functionality.

I can see how the wording might be confusing. Currently this package is a peer dependency of @powersync/react-native. In some circumstances peer dependencies are automatically installed, in which case there is no need to directly install this package.

We can improve the message on this readme.

@guillempuche
Copy link
Author

guillempuche commented Sep 11, 2024

Then our repos need to install it to be sure?

@stevensJourney
Copy link
Collaborator

Then our repos need to install it to be sure?

You will quickly notice if this package is not installed. It's only necessary to explicitly install this package if your project has explicitly disabled installation of peer dependencies.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants