Skip to content

Commit acf4ae7

Browse files
authored
docs(shadcn-ui): update README (#203)
1 parent 4a794a3 commit acf4ae7

3 files changed

Lines changed: 42 additions & 1 deletion

File tree

.changeset/cold-humans-rest.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"shadcn-ui": patch
3+
---
4+
5+
update readme

.github/workflows/prerelease-comment.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,6 @@ jobs:
6060
github.rest.issues.removeLabel({
6161
owner: context.repo.owner,
6262
repo: context.repo.repo,
63-
issue_number: ${{ env.WORKFLOW_RUN_PR }},
63+
issue_number: '${{ env.WORKFLOW_RUN_PR }}',
6464
name: '🚀 autorelease',
6565
});

packages/cli/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,43 @@
11
# shadcn-ui
22

3+
A CLI for adding components to your project.
4+
35
## Usage
46

7+
Use the `init` command to initialize dependencies for a new project.
8+
9+
The `init` command installs dependencies, adds the `cn` util, configures `tailwind.config.js`, and CSS variables for the project.
10+
11+
```bash
12+
npx shadcn-ui init
513
```
14+
15+
## add
16+
17+
Use the `add` command to add components to your project.
18+
19+
The `add` command adds a component to your project and installs all required dependencies.
20+
21+
```bash
22+
npx shadcn-ui add [component]
23+
```
24+
25+
### Example
26+
27+
```bash
28+
npx shadcn-ui add alert-dialog
29+
```
30+
31+
You can also run the command without any arguments to view a list of all available components:
32+
33+
```bash
634
npx shadcn-ui add
735
```
36+
37+
## Documentation
38+
39+
Visit http://ui.shadcn.com/docs to view the documentation.
40+
41+
## License
42+
43+
Licensed under the [MIT license](https://github.com/shadcn/ui/blob/main/LICENSE.md).

0 commit comments

Comments
 (0)