chore: update package, readme
This commit is contained in:
parent
f013a754e6
commit
eefea462e9
|
|
@ -2,57 +2,56 @@
|
||||||
Get your module up and running quickly.
|
Get your module up and running quickly.
|
||||||
|
|
||||||
Find and replace all on all files (CMD+SHIFT+F):
|
Find and replace all on all files (CMD+SHIFT+F):
|
||||||
- Name: My Module
|
- Name: Shadcn Nuxt
|
||||||
- Package name: my-module
|
- Package name: shadcn-nuxt
|
||||||
- Description: My new Nuxt module
|
- Description: My new Nuxt module
|
||||||
-->
|
-->
|
||||||
|
|
||||||
# My Module
|
# Shadcn Nuxt
|
||||||
|
|
||||||
[![npm version][npm-version-src]][npm-version-href]
|
[![npm version][npm-version-src]][npm-version-href]
|
||||||
[![npm downloads][npm-downloads-src]][npm-downloads-href]
|
[![npm downloads][npm-downloads-src]][npm-downloads-href]
|
||||||
[![License][license-src]][license-href]
|
[![License][license-src]][license-href]
|
||||||
[![Nuxt][nuxt-src]][nuxt-href]
|
[![Nuxt][nuxt-src]][nuxt-href]
|
||||||
|
|
||||||
My new Nuxt module for doing amazing things.
|
Shadcn Vue module for Nuxt.
|
||||||
|
|
||||||
- [✨ Release Notes](/CHANGELOG.md)
|
- [✨ Release Notes](/CHANGELOG.md)
|
||||||
<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/my-module?file=playground%2Fapp.vue) -->
|
<!-- - [🏀 Online playground](https://stackblitz.com/github/radix-vue/shadcn-vue?file=playground%2Fapp.vue) -->
|
||||||
<!-- - [📖 Documentation](https://example.com) -->
|
- [📖 Documentation](https://www.shadcn-vue.com/docs/installation/nuxt.html)
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
<!-- Highlight some of the features your module provide here -->
|
<!-- Highlight some of the features your module provide here -->
|
||||||
- ⛰ Foo
|
- ⛰ Auto-import correct and relevant components
|
||||||
- 🚠 Bar
|
- more to come...
|
||||||
- 🌲 Baz
|
|
||||||
|
|
||||||
## Quick Setup
|
## Quick Setup
|
||||||
|
|
||||||
1. Add `my-module` dependency to your project
|
1. Add `shadcn-nuxt` dependency to your project
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Using pnpm
|
# Using pnpm
|
||||||
pnpm add -D my-module
|
pnpm add -D shadcn-nuxt
|
||||||
|
|
||||||
# Using yarn
|
# Using yarn
|
||||||
yarn add --dev my-module
|
yarn add --dev shadcn-nuxt
|
||||||
|
|
||||||
# Using npm
|
# Using npm
|
||||||
npm install --save-dev my-module
|
npm install --save-dev shadcn-nuxt
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Add `my-module` to the `modules` section of `nuxt.config.ts`
|
2. Add `shadcn-nuxt` to the `modules` section of `nuxt.config.ts`
|
||||||
|
|
||||||
```js
|
```js
|
||||||
export default defineNuxtConfig({
|
export default defineNuxtConfig({
|
||||||
modules: [
|
modules: [
|
||||||
'my-module'
|
'shadcn-nuxt'
|
||||||
]
|
]
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
That's it! You can now use My Module in your Nuxt app ✨
|
That's it! You can now use Shadcn Nuxt in your Nuxt app ✨
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
|
|
@ -81,14 +80,14 @@ npm run release
|
||||||
```
|
```
|
||||||
|
|
||||||
<!-- Badges -->
|
<!-- Badges -->
|
||||||
[npm-version-src]: https://img.shields.io/npm/v/my-module/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
|
[npm-version-src]: https://img.shields.io/npm/v/shadcn-nuxt/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
|
||||||
[npm-version-href]: https://npmjs.com/package/my-module
|
[npm-version-href]: https://npmjs.com/package/shadcn-nuxt
|
||||||
|
|
||||||
[npm-downloads-src]: https://img.shields.io/npm/dm/my-module.svg?style=flat&colorA=18181B&colorB=28CF8D
|
[npm-downloads-src]: https://img.shields.io/npm/dm/shadcn-nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D
|
||||||
[npm-downloads-href]: https://npmjs.com/package/my-module
|
[npm-downloads-href]: https://npmjs.com/package/shadcn-nuxt
|
||||||
|
|
||||||
[license-src]: https://img.shields.io/npm/l/my-module.svg?style=flat&colorA=18181B&colorB=28CF8D
|
[license-src]: https://img.shields.io/npm/l/shadcn-nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D
|
||||||
[license-href]: https://npmjs.com/package/my-module
|
[license-href]: https://npmjs.com/package/shadcn-nuxt
|
||||||
|
|
||||||
[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
|
[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
|
||||||
[nuxt-href]: https://nuxt.com
|
[nuxt-href]: https://nuxt.com
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
{
|
{
|
||||||
"name": "module",
|
"name": "shadcn-nuxt",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"version": "0.8.3",
|
"version": "0.1.0",
|
||||||
"description": "Add shadcn-vue module to Nuxt",
|
"description": "Add shadcn-vue module to Nuxt",
|
||||||
"publishConfig": {
|
"publishConfig": {
|
||||||
"access": "public"
|
"access": "public"
|
||||||
|
|
@ -31,7 +31,8 @@
|
||||||
"dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
|
"dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
|
||||||
"lint": "eslint .",
|
"lint": "eslint .",
|
||||||
"test": "vitest run",
|
"test": "vitest run",
|
||||||
"test:watch": "vitest watch"
|
"test:watch": "vitest watch",
|
||||||
|
"release": "pnpm run prepack && pnpm publish && git push --follow-tags"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@nuxt/kit": "^3.8.2",
|
"@nuxt/kit": "^3.8.2",
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user