Skip to content

Commit

Permalink
docs: remove outdated pnpm deps
Browse files Browse the repository at this point in the history
Historically, docs instructed users to install this library as a development dependency. This caused the direct dependency to not be installed (as expected) for pnpm.

Guidance has changed to install the library as a direct dependency instead. As such, the instructions should be updated.
  • Loading branch information
metonym committed Dec 27, 2024
1 parent 4240f4e commit dec30af
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 4 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The Changelog is [available on GitHub](https://github.com/metonym/svelte-highlig
npm i svelte-highlight

# pnpm
pnpm i svelte-highlight highlight.js
pnpm i svelte-highlight

# Bun
bun i svelte-highlight
Expand All @@ -27,8 +27,6 @@ bun i svelte-highlight
yarn add svelte-highlight
```

Note that [pnpm](https://github.com/pnpm/pnpm) users must also install `highlight.js`.

## Basic Usage

The `Highlight` component requires two props:
Expand Down
2 changes: 1 addition & 1 deletion www/components/globals/Index.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
</Column>
<Column xlg={6} lg={9}>
<CodeSnippet code="npm i {PKG_NAME}" /><br />
<CodeSnippet code="pnpm i {PKG_NAME} highlight.js" /><br />
<CodeSnippet code="pnpm i {PKG_NAME}" /><br />
<CodeSnippet code="bun add {PKG_NAME}" /><br />
<CodeSnippet code="yarn add {PKG_NAME}" />
</Column>
Expand Down

0 comments on commit dec30af

Please sign in to comment.