chore: update readme

README.md

@@ -6,12 +6,12 @@ Welcome to contribute this repo
 
 Varlet Module for Nuxt3
 
-## Future
+## Feature
 
-- [x] ~~Make up the Lazy Option~~
-- Component Demo for Playground
-- [x] ~~Template for Nuxt3~~
-- [x] ~~Supports the directive~~
+- Auto import Varlet component in you Nuxt Project
+- Auto import Varlet the directive
+- Lazy load component
+- Material Design Nuxt Component with Material 3 Version
 
 ## Quick Setup
 
@@ -36,15 +36,23 @@ export default defineNuxtConfig({
     '@varlet/nuxt'
   ],
   varlet: {
-    ...
-  }
+    modulePath: '...',
+    exclude: ['...']
+  },
 })
 ```
 
 That's it! You can now use Varlet Module in your Nuxt app ✨
 
 tips: If you running `varlet` on the PC. Please install [`@varlet/touch-emulator`](https://varlet.gitee.io/varlet-ui/#/zh-CN/browserAdaptation)
 
+### Options
+
+|fieldName|require|default|effect|
+|--|--|--|--|
+|modulePath|false|undefind|customer you workspace path if you want|
+|exclude|false|'.nuxt', 'node_modules'|exclude some path that you won't transform|
+
 ## Contribution
 
 We recommend using pnpm

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@varlet/nuxt",
   "type": "module",
-  "version": "0.0.10",
+  "version": "0.1.0",
   "packageManager": "pnpm@7.22.0",
   "description": "varlet module for nuxt",
   "license": "MIT",
@@ -37,6 +37,9 @@
     "release": "npm run build && npx changelogen --release && npm publish && git push --follow-tags",
     "lint": "eslint . --fix"
   },
+  "peerDependencies": {
+    "@varlet/ui": "latest"
+  },
   "dependencies": {
     "@nuxt/kit": "^3.3.2",
     "@varlet/ui": "latest",
@@ -76,4 +79,4 @@
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   }
-}
+}