Skip to content

Commit a809373

Browse files
committed
docs(readme): Add example
1 parent a71522e commit a809373

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,23 @@ deno install -A -n rcc jsr:@sebkolind/react-component-cli
2020
rcc <component-name>/<sub-component-name> [/<sub-component-name> ...]
2121
```
2222

23+
## Example
24+
25+
With the default configuration, which can be seen below, this command:
26+
27+
```sh
28+
rcc MyComponent/MySubComponent
29+
```
30+
31+
will generate the following files:
32+
33+
- `MyComponent.tsx`
34+
- `MyComponent.module.scss`
35+
- `MyComponent/index.ts`
36+
- `MyComponent/MySubComponent/MySubComponent.tsx`
37+
- `MyComponent/MySubComponent/MySubComponent.module.scss`
38+
- `MyComponent/MySubComponent/index.ts`
39+
2340
## Configuration
2441

2542
Create a configuration file at `~/.config/@sebkolind/rcc/config.yml` to customize the

0 commit comments

Comments
 (0)