Skip to content

docs: keep the README short and link to nuxt.com/modules/icon - #566

Merged
atinux merged 2 commits into
mainfrom
readme
Oct 28, 2026
Merged

atinux merged 2 commits into
mainfrom
readme

Conversation

@atinux

@atinux atinux commented Oct 28, 2026

Copy link
Copy Markdown
Member

Opened by an AI agent (Amp) on behalf of @atinux.

The docs now live in docs/ (#554) and are published on nuxt.com/modules/icon. This keeps the README short instead of duplicating them:

  • Intro, links (documentation, release notes, playground) and features. The outdated "Nuxt 3 ready" and v0.6 migration note are dropped.
  • Quick setup with npx nuxt add icon and a <Icon> example.
  • Links to each docs page: usage, configuration, server and client bundles, icon customization, custom collections, testing.
  • Contributing, credits and license as before. Links now point at nuxt/icon instead of nuxt-modules/icon, and the Volta board badge is removed.

Every link in the README was checked and resolves.

The full documentation now lives in `docs/` and is published on
https://nuxt.com/modules/icon: the README keeps the intro, features, quick
setup, and links to each docs page.

Amp-Thread-ID: https://ampcode.com/threads/T-01a1721c-4512-7150-9905-efce9f4b7f68
@pkg-pr-new

pkg-pr-new Bot commented Oct 28, 2026

Copy link
Copy Markdown
npm i https://pkg.pr.new/@nuxt/icon@566

commit: c8734ab

Comment thread README.md Resolved
Comment thread README.md Resolved
Co-authored-by: Sébastien Chopin <atinux@gmail.com>
@atinux
atinux merged commit 3ce7f60 into main Oct 28, 2026
2 checks passed
@atinux
atinux deleted the readme branch October 28, 2026 13:55
@github-actions github-actions Bot mentioned this pull request Oct 28, 2026
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.

1 participant