@chewel611/naive-ui-plus 0.0.1

package/README.md

@@ -0,0 +1,73 @@
+# naive-plus-ui
+
+## Document & Online preview
+
+[Naive Plus UI](https://gitee.com/chewel/naive-ui-plus)
+
+## Install & Use
+
+```bash
+pnpm i @chewel/naive-plus-ui
+# or
+npm install @chewel/naive-plus-ui
+# or
+yarn add @chewel/naive-plus-ui
+```
+
+Import and register component
+
+**Global**
+
+```ts
+import { createApp } from 'vue'
+import App from './App.vue'
+
+import NaivePlusUI from '@chewel/naive-plus-ui'
+
+const app = createApp(App)
+app.use(NaivePlusUI)
+```
+
+**Local**
+
+```vue
+<script setup lang="ts">
+import { PlusTable } from '@chewel/naive-plus-ui'
+</script>
+```
+
+## Project
+
+- Get the project code
+
+```sh
+git clone gitee.com/chewel/naive-ui-plus.git
+```
+
+- Install dependencies
+
+```sh
+cd naive-plus-ui
+
+yarn i
+```
+
+- Run project
+
+```sh
+yarn dev
+```
+
+## tailwindcss 
+
+由于本项目使用了 tailwindcss，并且并没有把样式都打包到项目中，要求各自的项目中安装 tailwindcss，并且配置好 tailwindcss 的配置文件。
+
+```js
+module.exports = {
+  content: ['./node_modules/@chewel/naive-ui-plus/**/*.{vue,ts,tsx,js}'],
+  important: true,
+  theme: {
+    extend: {},
+  },
+};
+```