gpuweb / types

TypeScript type definitions for WebGPU https://gpuweb.github.io/types/
https://www.npmjs.com/package/@webgpu/types
BSD 3-Clause "New" or "Revised" License
189 stars 38 forks source link

Update install section in README #146

Closed lucaschang95 closed 10 months ago

lucaschang95 commented 11 months ago

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.