docs: correct pnpm installation command and prioritize pnpm in README#461
Open
samueltuoyo15 wants to merge 1 commit intodeepgram:mainfrom
Open
docs: correct pnpm installation command and prioritize pnpm in README#461samueltuoyo15 wants to merge 1 commit intodeepgram:mainfrom
samueltuoyo15 wants to merge 1 commit intodeepgram:mainfrom
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
I was skimming through the README and noticed a small mix-up in the installation section.
The Development Setup says to use pnpm for consistency (since the project uses Corepack), but the installation examples still list npm at the top. Also, for the pnpm example, it was using pnpm install instead of pnpm add, which is what people actually need when adding the SDK to their project.
I know it's a minor thing, but I’ve updated it to:
Put the pnpm command first so it matches the project's preferred setup.
Change the command to pnpm add @deepgram/sdk so it's technically correct.
Just wanted to make the onboarding a bit smoother for the next person. Cheers!