Skip to content

docs: update README, add section for how to install#1929

Merged
danielroe merged 1 commit into
nuxt:mainfrom
cadamsdev:cadamsdev/update-readme
Aug 22, 2025
Merged

docs: update README, add section for how to install#1929
danielroe merged 1 commit into
nuxt:mainfrom
cadamsdev:cadamsdev/update-readme

Conversation

@cadamsdev

@cadamsdev cadamsdev commented Aug 21, 2025

Copy link
Copy Markdown
Contributor

🔗 Linked issue

n/a

❓ Type of change

  • 📖 Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • 👌 Enhancement (improving an existing functionality)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

This PR updates the README to add a section for how to install the package. This is useful so devs can look at the modules page
https://nuxt.com/modules/image
and know how to install it without having to click a separate link to get to the documentation.

This is also consistent with other official nuxt modules that have an Installation section in the README.

Related PR

@cadamsdev
cadamsdev requested a review from danielroe as a code owner August 21, 2025 00:36
@vercel

vercel Bot commented Aug 21, 2025

Copy link
Copy Markdown

@cadamsdev is attempting to deploy a commit to the NuxtLabs Team on Vercel.

A member of the Team first needs to authorize it.

@pkg-pr-new

pkg-pr-new Bot commented Aug 21, 2025

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/@nuxt/image@1929

commit: 2fda10e

@danielroe
danielroe merged commit 4f5ad19 into nuxt:main Aug 22, 2025
4 of 7 checks passed
@github-actions github-actions Bot mentioned this pull request Aug 22, 2025
@cadamsdev
cadamsdev deleted the cadamsdev/update-readme branch August 22, 2025 13:39
@github-actions github-actions Bot mentioned this pull request Nov 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants