birdpaper-ui/README.md

一个通用的 vue3 UI组件库。A common vue3 UI component library.

<p align="center">
  <a href="https://www.birdpaper.design">
    <img class="logo" src="https://birdpaper-1251999712.cos.ap-guangzhou.myqcloud.com/design/assets/bp%2Bvue.png"/>
  </a>
</p>

<p align="center">birdpaper-ui is a common vue3 UI component library.</p>

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

birdpaper-ui for v2 (Ogino Chihiro) is published.

## Getting Started

In order to better understand birdpaper-ui, you may need to read this manual carefully; For developers, the need for more in-depth instructions document, you can access [快速上手](https://www.birdpaper.design).

birdpaper-ui is a general-purpose UI component library that is written based on Vue3 and provides a set of web-friendly component scenarios. At present by the author [木亦Sam](https://github.com/liluanhui) for maintenance.

### Feature

- 🐬 Vue3 Composite API
- 👨🏻‍💻 Written in TypeScript
- 🎨 Comprehensive design resources (in progress)

### Document site

There are currently two sites that can access the project documents, and for better access experience, the documents will be deployed to more places in the future.

- 中国大陆推荐访问 [官方文档](https://www.birdpaper.design)
- [Github Page](https://birdpaper-team.github.io/birdpaper-ui/)

### Product planning

About the function of the project plan, version requirements, scheduling and other information, you can access [产品计划](https://birdpaper.feishu.cn/base/XuwfbzYJZaXsQ4shv6rcl1J4nNb) to understand; You can also submit feedback and defects, I will keep an eye on and follow up.

I sincerely hope that you can participate in the construction of the project, Submit by [提交反馈](https://birdpaper.feishu.cn/share/base/form/shrcn5frnnnGQ8srrudH9wV0TMh) or [Github Issues](https://github.com/birdpaper-team/birdpaper-ui/issues)

## License

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