birdpaper-icon/README.md

基于 Remix icon 生成的 Vue3 图标组件库

<p align="center">
  <a href="https://icon.birdpaper.design">
    <img class="logo" style="width: 60%" src="https://cos.birdpaper.design/birdpaper-icon/v1/logo/bp%2Bremix%404x.png"/>
  </a>
</p>

This is an open source Vue3 component based on the excellent Icon library - [RemixIcon](https://remixicon.com/) second development, for learning and reference use only, thanks to the Remix Design team.

<p align="center">
  <a href="https://www.npmjs.com/package/birdpaper-icon" target="_blank">
     <img class="tag" src="https://img.shields.io/npm/v/birdpaper-icon.svg?style=badge"/>
  </a>
  <a href="https://npmcharts.com/compare/birdpaper-icon?minimal=true">
    <img class="tag" src="http://img.shields.io/npm/dm/birdpaper-icon.svg"/>
  </a>
   <a href="https://icon.birdpaper.design">
    <img class="tag" src="https://img.shields.io/badge/platform-Vue3-059669.svg"/>
  </a>
   <a href="https://icon.birdpaper.design">
    <img class="tag" src="https://img.shields.io/badge/license-MIT-red.svg"/>
  </a>
</p>

## Getting Started

You need install first it.

```
npm install birdpaper-icon
```

## Use

In your `main.js` file.

```js
import { createApp } from "vue";
import App from "./App.vue";

import BirdpaperIcon from "birdpaper-icon";
import "birdpaper-icon/dist/index.css";

const app = createApp(App);
app.use(BirdpaperIcon).mount("#app");
```

For more information, you need to visit the [官方文档](https://icon.birdpaper.design)

## License

birdpaper-icon use at [MIT](https://github.com/birdpaper-team/birdpaper-icon/LICENSE) open source licenses.