Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update readme to reflect actual CLI docs (updated npx command) #4949

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update readme to reflect actual CLI docs (updated npx command) #4949

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions packages/cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ 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
npx shadcn init
```

## add
Expand All @@ -19,19 +19,19 @@ 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]
npx shadcn add [component]
```

### Example

```bash
npx shadcn-ui add alert-dialog
npx shadcn 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
npx shadcn add
```

## Documentation
Expand Down