Update install section in README #146
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kainino0x
approved these changes
Jan 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request updates the installation section of the README to recommend installing @webgpu/types as a development dependency rather than a production dependency. The changes reflect the more common use case where @webgpu/types is used during development for type checking and not required in the production build.
The updated installation commands are as follows:
For npm users, the command has been changed from npm install --save @webgpu/types to npm install --save-dev @webgpu/types.
For yarn users, the command has been changed from yarn add @webgpu/types to yarn add --dev @webgpu/types.
Additionally, I've added the installation command for pnpm users: pnpm add -D @webgpu/types.
These changes ensure that the package is added to the devDependencies section of the package.json, which is more appropriate for type definitions that are typically not needed in the final production bundle.
Please consider merging this pull request to make the installation instructions clearer and more accurate for developers using @webgpu/types.