From 9399f6606a438c4f9e713ea09fa58b0fcffd0c30 Mon Sep 17 00:00:00 2001 From: zernonia Date: Wed, 6 Sep 2023 10:19:39 +0800 Subject: [PATCH] chore: publish cli --- package.json | 4 +++- packages/cli/README.md | 43 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+), 1 deletion(-) create mode 100644 packages/cli/README.md diff --git a/package.json b/package.json index 4c71aadf..c00b9916 100644 --- a/package.json +++ b/package.json @@ -16,7 +16,9 @@ "lint:fix": "eslint . --fix --ignore-path .gitignore", "dev:cli": "pnpm --filter shadcn-vue dev", "build:cli": "pnpm --filter shadcn-vue build", - "build:registry": "pnpm --filter=www build:registry" + "build:registry": "pnpm --filter=www build:registry", + "pub:beta": "cd packages/cli && pnpm pub:beta", + "pub:release": "cd packages/cli && pnpm pub:release" }, "devDependencies": { "@antfu/eslint-config": "^0.39.7", diff --git a/packages/cli/README.md b/packages/cli/README.md new file mode 100644 index 00000000..79284cfb --- /dev/null +++ b/packages/cli/README.md @@ -0,0 +1,43 @@ +# shadcn-vue + +A CLI for adding components to your project. + +## Usage + +Use the `init` command to initialize dependencies for a new project. + +The `init` command installs dependencies, adds the `cn` util, configures `tailwind.config.js`, and CSS variables for the project. + +```bash +npx shadcn-vue init +``` + +## add + +Use the `add` command to add components to your project. + +The `add` command adds a component to your project and installs all required dependencies. + +```bash +npx shadcn-vue add [component] +``` + +### Example + +```bash +npx shadcn-vue add alert-dialog +``` + +You can also run the command without any arguments to view a list of all available components: + +```bash +npx shadcn-vue add +``` + +## Documentation + +Visit http://ui.shadcn.com/docs to view the documentation. + +## License + +Licensed under the [MIT license](https://github.com/shadcn/ui/blob/main/LICENSE.md). \ No newline at end of file