Skip to content

chore: update readme to use 'pnpm' instead 'yarn' and 'npm' #1597

@tejaskh3

Description

@tejaskh3

what's wrong with the documentation?

Issue Description

  • The current README file still uses npm and yarn for package management. However, our project has standardized on pnpm, and continuing to mention npm or yarn may confuse new contributors.

  • We need to update the README to clearly instruct contributors to use pnpm for installing dependencies, running scripts, and contributing to the project.

  • Additionally, yarn should be removed from the main dependencies. If it’s required for specific development tasks, it should be listed under devDependencies instead. Keeping it in dependencies unnecessarily bloats the build and increases install time.

Expected Outcome

The README should provide clear, accurate, and consistent setup instructions using pnpm only, ensuring a smoother onboarding experience for new contributors.

Add screenshots

Image

Record

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions