diff --git a/.changeset/cold-humans-rest.md b/.changeset/cold-humans-rest.md new file mode 100644 index 000000000..ac97fd8da --- /dev/null +++ b/.changeset/cold-humans-rest.md @@ -0,0 +1,5 @@ +--- +"shadcn-ui": patch +--- + +update readme diff --git a/.github/workflows/prerelease-comment.yml b/.github/workflows/prerelease-comment.yml index 1a9af5dc8..51a4e55da 100644 --- a/.github/workflows/prerelease-comment.yml +++ b/.github/workflows/prerelease-comment.yml @@ -60,6 +60,6 @@ jobs: github.rest.issues.removeLabel({ owner: context.repo.owner, repo: context.repo.repo, - issue_number: ${{ env.WORKFLOW_RUN_PR }}, + issue_number: '${{ env.WORKFLOW_RUN_PR }}', name: '🚀 autorelease', }); diff --git a/packages/cli/README.md b/packages/cli/README.md index e1b698322..a9d202577 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -1,7 +1,43 @@ # shadcn-ui +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-ui 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-ui add [component] +``` + +### Example + +```bash +npx shadcn-ui add alert-dialog +``` + +You can also run the command without any arguments to view a list of all available components: + +```bash npx shadcn-ui 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).