Skip to content

Commit

Permalink
docs(readme): add examples
Browse files Browse the repository at this point in the history
  • Loading branch information
JaZo committed May 30, 2023
1 parent 61067be commit 575031c
Showing 1 changed file with 27 additions and 4 deletions.
31 changes: 27 additions & 4 deletions README.md
Expand Up @@ -37,20 +37,43 @@ npm install --save-dev nuxt-lucide-icons

2. Add `nuxt-lucide-icons` to the `modules` section of `nuxt.config.ts`

```js
```ts
export default defineNuxtConfig({
modules: [
'nuxt-lucide-icons'
]
})
```

3. That's it! You can now use [all Lucide icons](https://lucide.dev/icons) in your Nuxt app ✨

```vue
<template>
<div>
<h1>Nuxt Lucide Icons</h1>
<LucideRocket />
<LucideFolderGit2 color="red" />
<LucideGithub :size="32" />
</div>
</template>
```

## Configuration

Don't like the default component name prefix? You can change it in `nuxt.config.ts`:

```ts
export default defineNuxtConfig({
modules: [
'nuxt-lucide-icons'
],

lucide: {
namePrefix: 'Lucide'
namePrefix: 'Icon'
}
})
```

That's it! You can now use all Lucide icons in your Nuxt app ✨

## Development

```bash
Expand Down

0 comments on commit 575031c

Please sign in to comment.