lew-ui 1.0.13 → 1.0.16

package/README.md

@@ -1,16 +1,30 @@
-# Vue 3 + TypeScript + Vite
+# Lew-UI
 
-This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
+A Component Library for Vue3.js.
+Doc address: https://lew.kamtao.com
 
-## Recommended IDE Setup
 
-- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar)
+## Install
 
-## Type Support For `.vue` Imports in TS
+```bash
+npm install lew-ui --save
+```
 
-Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can enable Volar's Take Over mode by following these steps:
+## How to use
 
-1. Run `Extensions: Show Built-in Extensions` from VS Code's command palette, look for `TypeScript and JavaScript Language Features`, then right click and select `Disable (Workspace)`. By default, Take Over mode will enable itself if the default TypeScript extension is disabled.
-2. Reload the VS Code window by running `Developer: Reload Window` from the command palette.
+引入css
+```js
+// main.ts
+import "lew-ui/dist/style.css";
+```
 
-You can learn more about Take Over mode [here](https://github.com/johnsoncodehk/volar/discussions/471).
+页面
+```vue
+<script setup lang="ts">
+import { LewButton } from 'lew-ui';
+</script>
+
+<template>
+    <lew-button> 发送 </lew-button>
+</template>
+```