Skip to content

chore: update README with bun support and bump deps #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fengmk2 merged 1 commit into from
Apr 3, 2026
+283 −263
Merged

chore: update README with bun support and bump deps #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ GitHub Action to set up [Vite+](https://viteplus.dev) (`vp`) with dependency cac
- Optionally set up a specific Node.js version via `vp env use`
- Cache project dependencies with auto-detection of lock files
- Optionally run `vp install` after setup
- Support for all major package managers (npm, pnpm, yarn)
- Support for all major package managers (npm, pnpm, yarn, bun)

## Usage

Expand Down Expand Up @@ -176,6 +176,8 @@ When `cache: true` is set, the action additionally caches project dependencies b
| Lock File | Package Manager | Cache Directory |
| ------------------- | --------------- | --------------- |
| `pnpm-lock.yaml` | pnpm | pnpm store |
| `bun.lockb` | bun | bun cache |
| `bun.lock` | bun | bun cache |
| `package-lock.json` | npm | npm cache |
| `yarn.lock` | yarn | yarn cache |
Comment on lines 176 to 182
Copy link

Copilot AI Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The lockfile auto-detection supports npm-shrinkwrap.json as an npm lock file, but it isn’t listed in this dependency caching table. Since this table is being updated, consider adding an npm-shrinkwrap.json row to keep the README accurate.

Suggested change
| Lock File | Package Manager | Cache Directory |
| ------------------- | --------------- | --------------- |
| `pnpm-lock.yaml` | pnpm | pnpm store |
| `bun.lockb` | bun | bun cache |
| `bun.lock` | bun | bun cache |
| `package-lock.json` | npm | npm cache |
| `yarn.lock` | yarn | yarn cache |
| Lock File | Package Manager | Cache Directory |
| ---------------------- | --------------- | --------------- |
| `pnpm-lock.yaml` | pnpm | pnpm store |
| `bun.lockb` | bun | bun cache |
| `bun.lock` | bun | bun cache |
| `package-lock.json` | npm | npm cache |
| `npm-shrinkwrap.json` | npm | npm cache |
| `yarn.lock` | yarn | yarn cache |

Copilot uses AI. Check for mistakes.

Expand Down
Loading
Loading