Skip to content

Commit 24f4374

Browse files
committed
docs(readme): Add args section
1 parent b9459be commit 24f4374

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,11 @@
1-
# React Component CLI
1+
# React Create Component CLI
22

33
A CLI tool to generate React components with ease.
44

5-
## Features
6-
7-
- Generate React components with customizable templates
8-
- Supports different case formats for component names
9-
- Automatically creates style files and index files
10-
115
## Installation
126

7+
This will install the CLI tool globally under the name `rcc`.
8+
139
```sh
1410
deno install -A -n rcc jsr:@sebkolind/react-component-cli
1511
```
@@ -20,6 +16,12 @@ deno install -A -n rcc jsr:@sebkolind/react-component-cli
2016
rcc <component-name>/<sub-component-name> [/<sub-component-name> ...]
2117
```
2218

19+
### Arguments
20+
21+
- `barrels` (boolean): Generate barrel files for each component. Default: `true`
22+
- `flat` (boolean): Generate files in a flat structure. Default: `false`
23+
- `styles` (boolean): Generate style files for each component. Default: `true`
24+
2325
## Example
2426

2527
With the default configuration, which can be seen below, this command:

0 commit comments

Comments
 (0)