diff --git a/CHANGELOG.md b/CHANGELOG.md index f6fd7fc..77f65ce 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +# [2.0.0](https://github.com/fengyuanchen/vue-feather/compare/v2.0.0-rc.1...v2.0.0) (2022-02-07) + + + # [2.0.0-rc.1](https://github.com/fengyuanchen/vue-feather/compare/v2.0.0-rc...v2.0.0-rc.1) (2021-10-23) diff --git a/README.md b/README.md index b529783..aa2c924 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # vue-feather -[![Coverage Status](https://img.shields.io/codecov/c/github/fengyuanchen/vue-feather.svg)](https://codecov.io/gh/fengyuanchen/vue-feather) [![Downloads](https://img.shields.io/npm/dm/vue-feather.svg)](https://www.npmjs.com/package/vue-feather) [![Version](https://img.shields.io/npm/v/vue-feather/next.svg)](https://www.npmjs.com/package/vue-feather) [![Gzip Size](https://img.shields.io/bundlephobia/minzip/vue-feather.svg)](https://unpkg.com/vue-feather/dist/vue-feather.js) +[![Coverage Status](https://img.shields.io/codecov/c/github/fengyuanchen/vue-feather.svg)](https://codecov.io/gh/fengyuanchen/vue-feather) [![Downloads](https://img.shields.io/npm/dm/vue-feather.svg)](https://www.npmjs.com/package/vue-feather) [![Version](https://img.shields.io/npm/v/vue-feather.svg)](https://www.npmjs.com/package/vue-feather) [![Gzip Size](https://img.shields.io/bundlephobia/minzip/vue-feather.svg)](https://unpkg.com/vue-feather/dist/vue-feather.js) -> [Feather](https://feathericons.com/) icons component for Vue 3. +> [Feather](https://feathericons.com/) icons component for Vue 3. For Vue 2, check out the [`v1`](https://github.com/fengyuanchen/vue-feather/tree/v1) branch. - [Docs](src/README.md) - [Demo](https://fengyuanchen.github.io/vue-feather) @@ -14,23 +14,38 @@ dist/ ├── vue-feather.js (UMD, default) ├── vue-feather.min.js (UMD, compressed) ├── vue-feather.esm.js (ECMAScript Module) -└── vue-feather.esm.min.js (ECMAScript Module, compressed) +├── vue-feather.esm.min.js (ECMAScript Module, compressed) +└── vue-feather.d.ts (TypeScript Declaration File) ``` ## Getting started ### Installation +Using npm: + +```shell +npm install vue@3 feather-icons@4 vue-feather@2 +``` + +Using pnpm: + +```shell +pnpm add vue@3 feather-icons@4 vue-feather@2 +``` + +Using Yarn: + ```shell -npm install vue@next feather-icons vue-feather@next +yarn add vue@3 feather-icons@4 vue-feather@2 ``` -In browser: +Using CDN: ```html - - - + + + ``` ### Usage diff --git a/docs/app.vue b/docs/app.vue index 763bea4..bb33cab 100644 --- a/docs/app.vue +++ b/docs/app.vue @@ -149,6 +149,7 @@ export default defineComponent({ .markdown-body { table { display: table; + min-width: 100%; } code { diff --git a/docs/index.html b/docs/index.html index 6486867..4e37522 100644 --- a/docs/index.html +++ b/docs/index.html @@ -8,7 +8,7 @@ - +
@@ -18,6 +18,6 @@ - +