mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-07-09 06:55:07 +00:00
chore: deprecate shadcn-ui (#6780)
* chore: deprecate shadcn-ui * deps(shadcn-ui): remove unused dependencies * fix: tests * deps: bump version
This commit is contained in:
@@ -1,41 +1,9 @@
|
||||
# shadcn-ui
|
||||
|
||||
A CLI for adding components to your project.
|
||||
|
||||
> [!WARNING]
|
||||
> The shadcn-ui CLI is going to be deprecated soon. Bug fixes and new features should be added to the `.packages/shadcn` instead.
|
||||
> The shadcn-ui CLI is going to be deprecated soon. See [shadcn](https://ui.shadcn.com/docs/cli) for more information.
|
||||
|
||||
## 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
|
||||
```
|
||||
Bug fixes and new features should be added to the `.packages/shadcn` instead.
|
||||
|
||||
## Documentation
|
||||
|
||||
|
||||
Reference in New Issue
Block a user