nuxt / icon

The <Icon> component, supporting Iconify, Emojis and custom components.
https://stackblitz.com/edit/nuxt-icon-playground?file=app.vue
MIT License
864 stars 37 forks source link

Better README for v1 #177

Closed rylanharper closed 1 week ago

rylanharper commented 1 week ago

Hey there! Congrats on v1 release!

Everything is working well for me when upgrading from nuxt-icon to @nuxt/icon, which is great! This issue is mainly to suggest that should be a better documentation (within the README) on adding @nuxt/icon to the nuxt.config modules..

When running npx nuxi module add icon no @nuxt/icon was added to my modules within my nuxt.config either.. I had to manually install @nuxt/icon to my web dependencies (since I am working on a public repo), add it to my modules, and remove the old nuxt-icon. All of this is totally fine of course, but the README should list this out.

Other than that, everything works great so far 🚀