nuance-ui 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +49 -68
- package/dist/module.json +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,90 +1,71 @@
|
|
|
1
|
-
|
|
2
|
-
Get your module up and running quickly.
|
|
1
|
+
# Nuance-UI
|
|
3
2
|
|
|
4
|
-
|
|
5
|
-
- Name: My Module
|
|
6
|
-
- Package name: my-module
|
|
7
|
-
- Description: My new Nuxt module
|
|
8
|
-
-->
|
|
3
|
+
A modern UI kit module for Nuxt 3 with thoughtfully designed components and subtle interaction details.
|
|
9
4
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
[![npm version][npm-version-src]][npm-version-href]
|
|
13
|
-
[![npm downloads][npm-downloads-src]][npm-downloads-href]
|
|
14
|
-
[![License][license-src]][license-href]
|
|
15
|
-
[![Nuxt][nuxt-src]][nuxt-href]
|
|
16
|
-
|
|
17
|
-
My new Nuxt module for doing amazing things.
|
|
18
|
-
|
|
19
|
-
- [✨ Release Notes](/CHANGELOG.md)
|
|
20
|
-
|
|
21
|
-
<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/my-module?file=playground%2Fapp.vue) -->
|
|
22
|
-
<!-- - [📖 Documentation](https://example.com) -->
|
|
23
|
-
|
|
24
|
-
## Features
|
|
25
|
-
|
|
26
|
-
<!-- Highlight some of the features your module provide here -->
|
|
27
|
-
|
|
28
|
-
- ⛰ Foo
|
|
29
|
-
- 🚠 Bar
|
|
30
|
-
- 🌲 Baz
|
|
31
|
-
|
|
32
|
-
## Quick Setup 1
|
|
33
|
-
|
|
34
|
-
Install the module to your Nuxt application with one command:
|
|
5
|
+
## 📦 Installation
|
|
35
6
|
|
|
36
7
|
```bash
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
That's it! You can now use My Module in your Nuxt app ✨
|
|
41
|
-
|
|
42
|
-
## Contribution
|
|
8
|
+
# npm
|
|
9
|
+
npm install nuance-ui
|
|
43
10
|
|
|
44
|
-
|
|
45
|
-
|
|
11
|
+
# yarn
|
|
12
|
+
yarn add nuance-ui
|
|
46
13
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
# Generate type stubs
|
|
52
|
-
npm run dev:prepare
|
|
14
|
+
# pnpm
|
|
15
|
+
pnpm add nuance-ui
|
|
16
|
+
```
|
|
53
17
|
|
|
54
|
-
|
|
55
|
-
npm run dev
|
|
18
|
+
## Quick Start
|
|
56
19
|
|
|
57
|
-
|
|
58
|
-
npm run dev:build
|
|
20
|
+
Add `nuance-ui` to the `modules` section of your `nuxt.config.ts`:
|
|
59
21
|
|
|
60
|
-
|
|
61
|
-
|
|
22
|
+
```typescript
|
|
23
|
+
export default defineNuxtConfig({
|
|
24
|
+
modules: ['nuance-ui'],
|
|
25
|
+
})
|
|
26
|
+
```
|
|
62
27
|
|
|
63
|
-
|
|
64
|
-
npm run test
|
|
65
|
-
npm run test:watch
|
|
28
|
+
Now you can use components in your application:
|
|
66
29
|
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
30
|
+
```vue
|
|
31
|
+
<template>
|
|
32
|
+
<div>
|
|
33
|
+
<NButton variant='primary'>
|
|
34
|
+
Click me
|
|
35
|
+
</NButton>
|
|
70
36
|
|
|
71
|
-
|
|
37
|
+
<NCard>
|
|
38
|
+
<p>Card content goes here</p>
|
|
39
|
+
</NCard>
|
|
40
|
+
</div>
|
|
41
|
+
</template>
|
|
42
|
+
```
|
|
72
43
|
|
|
44
|
+
## Contributing
|
|
73
45
|
|
|
74
|
-
|
|
46
|
+
We welcome contributions! Please:
|
|
75
47
|
|
|
76
|
-
|
|
48
|
+
1. Fork the repository
|
|
49
|
+
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
|
|
50
|
+
3. Commit your changes (`git commit -m 'Add amazing feature'`)
|
|
51
|
+
4. Push to the branch (`git push origin feature/amazing-feature`)
|
|
52
|
+
5. Open a Pull Request
|
|
77
53
|
|
|
78
|
-
|
|
54
|
+
## Links
|
|
79
55
|
|
|
80
|
-
[
|
|
56
|
+
- [Documentation](https://nuance-ui.dev)
|
|
57
|
+
- [GitHub](https://github.com/yourusername/nuance-ui)
|
|
58
|
+
- [NPM](https://www.npmjs.com/package/nuance-ui)
|
|
59
|
+
- [Examples](https://nuance-ui.dev/examples)
|
|
81
60
|
|
|
82
|
-
|
|
61
|
+
## Support
|
|
83
62
|
|
|
84
|
-
|
|
63
|
+
If you have questions or issues:
|
|
85
64
|
|
|
86
|
-
[
|
|
65
|
+
- [Create an Issue](https://github.com/yourusername/nuance-ui/issues)
|
|
66
|
+
- [Discussions](https://github.com/yourusername/nuance-ui/discussions)
|
|
67
|
+
- Email: support@nuance-ui.dev
|
|
87
68
|
|
|
88
|
-
|
|
69
|
+
## License
|
|
89
70
|
|
|
90
|
-
|
|
71
|
+
Licensed under the MIT license.
|
package/dist/module.json
CHANGED