Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ewilan-riviere committed Sep 30, 2023
1 parent b5f17a3 commit beb0f4f
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,13 @@

Import easily your SVG. Powered by [unplugin](https://github.com/unjs/unplugin).

> Designed to be a replacement of [`kiwilan/nuxt-svg-transformer`](https://github.com/kiwilan/nuxt-svg-transformer), a Nuxt module.
Use SVG into modern tools is not easy, especially when you want to use SVG as component. This plugin will parse your SVG files and create a cache file to import them easily with a library index file. It works with any framework with Vite/Webpack, but some components are ready-to-use for Vue and React. You could also create your own component for your favorite framework. Built for TypeScript, but works with JavaScript.

> Designed to be a replacement of [`kiwilan/nuxt-svg-transformer`](https://github.com/kiwilan/nuxt-svg-transformer), a Nuxt module.
> **Warning**
>
> If you want to use SVG from icon sets, you should use [`unplugin-icons`](https://github.com/unplugin/unplugin-icons), a very good plugin from [unplugin](https://github.com/unplugin). `unplugin-svg-transformer` is good for custom SVG.
```ts
import type { SvgName } from 'unplugin-svg-transformer/icons'
Expand Down Expand Up @@ -51,8 +55,6 @@ const list = svgList // as Record<SvgName, () => Promise<{ default: string }>>
- [ ] Add Nuxt 2 support
- [ ] Add more tests
- [ ] Add SVGO support
- [ ] Add options of `nuxt-svg-transformer` module
- [ ] Add default SVG option

## Install

Expand Down

0 comments on commit beb0f4f

Please sign in to comment.