Skip to content

Update README.md #40

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #40

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: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ A module for Nuxt 3 that allows you to use your own SVG icons quickly and enjoya
[![playground-usage](https://i.imgur.com/SMXXpVu.png "example of using icons in project")](https://github.com/gitFoxCode/nuxt-icons)

## Installation
1. `npm i nuxt-icons`
1. `npm i -D nuxt-icons`
2. add `nuxt-icons` to modules, **nuxt.config.ts**:
```javascript
export default defineNuxtConfig({
Expand Down Expand Up @@ -58,4 +58,4 @@ The module retrieves all svg files from the assets/icons folder, overwrites the
- Automatic icon scaling that have non-square dimensions to maintain their proportions (maybe with preserveAspectRatio)
- <del>Usable for previous nuxt versions</del> (just use [something like this](https://github.com/gitFoxCode/TaleGalaxy/blob/main/client/src/components/SvgIcon.vue))

A big thank you to [@Diizzayy](https://github.com/Diizzayy) for his invaluable help in developing the project
A big thank you to [@Diizzayy](https://github.com/Diizzayy) for his invaluable help in developing the project