Skip to content

Commit 055e7d2

Browse files
committed
ci: update readme
1 parent ffc2cd6 commit 055e7d2

File tree

1 file changed

+53
-7
lines changed

1 file changed

+53
-7
lines changed

README.md

Lines changed: 53 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Find and replace all on all files (CMD+SHIFT+F):
1414
[![License][license-src]][license-href]
1515
[![Nuxt][nuxt-src]][nuxt-href]
1616

17-
My new Nuxt module for doing amazing things.
17+
[Ant Design Vue](https://www.antdv.com) module for [Nuxt](https://nuxt.com/)
1818

1919
- [ Release Notes](/CHANGELOG.md)
2020
<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/my-module?file=playground%2Fapp.vue) -->
@@ -23,13 +23,13 @@ My new Nuxt module for doing amazing things.
2323
## Features
2424

2525
<!-- Highlight some of the features your module provide here -->
26-
-&nbsp;Foo
27-
- 🚠 &nbsp;Bar
28-
- 🌲 &nbsp;Baz
26+
-&nbsp;Automatically import components on demand.
27+
- 🚠 &nbsp;Automatically import icons from [@ant-design/icons-vue](https://github.com/ant-design/ant-design-icons/tree/master/packages/icons-vue).
28+
- 🌲 &nbsp;Automatically import of message, notification and Modal methods.
2929

3030
## Quick Setup
3131

32-
1. Add `my-module` dependency to your project
32+
1. Add `@ant-design-vue/nuxt` dependency to your project
3333

3434
```bash
3535
# Using pnpm
@@ -48,11 +48,54 @@ npm install --save-dev @ant-design-vue/nuxt
4848
export default defineNuxtConfig({
4949
modules: [
5050
'@ant-design-vue/nuxt'
51-
]
51+
],
52+
antd:{
53+
// Options
54+
}
5255
})
5356
```
5457

55-
That's it! You can now use My Module in your Nuxt app ✨
58+
That's it! You can now use ant-design-vue in your Nuxt app ✨
59+
60+
61+
## Usage
62+
63+
```vue
64+
<script lang="ts" setup>
65+
const hanldeMessage = () => {
66+
message.info("This is a normal message");
67+
}
68+
</script>
69+
<template>
70+
<a-button @click="hanldeMessage">
71+
button
72+
</a-button>
73+
</template>
74+
```
75+
Reference [Nuxt documentation](https://nuxt.com/docs/guide/directory-structure/components) and [playground](./playground/app.vue) use.
76+
77+
## Options
78+
79+
### components
80+
81+
* Type: `array`
82+
83+
If there are components that are not imported automatically from Ant Design Vue, you need to add the component name here.
84+
85+
e.g.`['Button']`
86+
87+
### imports
88+
89+
* Type: `array`
90+
91+
If you wish to add automatically import content from Element Plus, you can add it here.
92+
93+
### icons
94+
95+
* Type: `array`
96+
97+
If there are components that are not imported automatically from @ant-design/icons-vue, you need to add the component name here.
98+
5699

57100
## Development
58101

@@ -69,6 +112,9 @@ npm run dev
69112
# Build the playground
70113
npm run dev:build
71114

115+
# Build for production
116+
npm run build
117+
72118
# Run ESLint
73119
npm run lint
74120

0 commit comments

Comments
 (0)