From eefea462e97d225dd77124c3b4c674ef984e786d Mon Sep 17 00:00:00 2001 From: zernonia Date: Fri, 1 Dec 2023 00:45:55 +0800 Subject: [PATCH] chore: update package, readme --- packages/module/README.md | 43 ++++++++++++++++++------------------ packages/module/package.json | 7 +++--- 2 files changed, 25 insertions(+), 25 deletions(-) diff --git a/packages/module/README.md b/packages/module/README.md index c51b6b07..21499e9f 100644 --- a/packages/module/README.md +++ b/packages/module/README.md @@ -2,57 +2,56 @@ Get your module up and running quickly. Find and replace all on all files (CMD+SHIFT+F): -- Name: My Module -- Package name: my-module +- Name: Shadcn Nuxt +- Package name: shadcn-nuxt - Description: My new Nuxt module --> -# My Module +# Shadcn Nuxt [![npm version][npm-version-src]][npm-version-href] [![npm downloads][npm-downloads-src]][npm-downloads-href] [![License][license-src]][license-href] [![Nuxt][nuxt-src]][nuxt-href] -My new Nuxt module for doing amazing things. +Shadcn Vue module for Nuxt. - [✨  Release Notes](/CHANGELOG.md) - - + +- [📖  Documentation](https://www.shadcn-vue.com/docs/installation/nuxt.html) ## Features -- ⛰  Foo -- 🚠  Bar -- 🌲  Baz +- ⛰ Auto-import correct and relevant components +- more to come... ## Quick Setup -1. Add `my-module` dependency to your project +1. Add `shadcn-nuxt` dependency to your project ```bash # Using pnpm -pnpm add -D my-module +pnpm add -D shadcn-nuxt # Using yarn -yarn add --dev my-module +yarn add --dev shadcn-nuxt # 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 export default defineNuxtConfig({ 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 @@ -81,14 +80,14 @@ npm run release ``` -[npm-version-src]: https://img.shields.io/npm/v/my-module/latest.svg?style=flat&colorA=18181B&colorB=28CF8D -[npm-version-href]: https://npmjs.com/package/my-module +[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/shadcn-nuxt -[npm-downloads-src]: https://img.shields.io/npm/dm/my-module.svg?style=flat&colorA=18181B&colorB=28CF8D -[npm-downloads-href]: https://npmjs.com/package/my-module +[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/shadcn-nuxt -[license-src]: https://img.shields.io/npm/l/my-module.svg?style=flat&colorA=18181B&colorB=28CF8D -[license-href]: https://npmjs.com/package/my-module +[license-src]: https://img.shields.io/npm/l/shadcn-nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D +[license-href]: https://npmjs.com/package/shadcn-nuxt [nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js [nuxt-href]: https://nuxt.com diff --git a/packages/module/package.json b/packages/module/package.json index 8b2859d8..e50bb047 100644 --- a/packages/module/package.json +++ b/packages/module/package.json @@ -1,7 +1,7 @@ { - "name": "module", + "name": "shadcn-nuxt", "type": "module", - "version": "0.8.3", + "version": "0.1.0", "description": "Add shadcn-vue module to Nuxt", "publishConfig": { "access": "public" @@ -31,7 +31,8 @@ "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground", "lint": "eslint .", "test": "vitest run", - "test:watch": "vitest watch" + "test:watch": "vitest watch", + "release": "pnpm run prepack && pnpm publish && git push --follow-tags" }, "dependencies": { "@nuxt/kit": "^3.8.2",