Skip to content

Commit 8cd771f

Browse files
authored
Update README.md
1 parent 9d4ac57 commit 8cd771f

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,14 @@ Create components based on the following structure (example given in js)
1414
### Installation
1515
- `yarn global add react-components-cli`
1616

17+
Note: You will need to add yarn global bin to your path like adding `export PATH="$(yarn global bin):$PATH"` in your .bashrc or .zshrc (or whatever on windows)
18+
1719
### Usage
1820
- Create any components type using prompts:
19-
- `yarn run create-component` (note: if global not found, add `yarn global dir` to your PATH)
21+
- `create-component` (note: if global not found, add `yarn global dir` to your PATH)
2022
### Examples
2123

22-
- `yarn run create-component -- --name FunctionComponent --directory src/components --componentType stateless --styled true --story false --componentCase camel`
24+
- `create-component -- --name FunctionComponent --directory src/components --componentType stateless --styled true --story false --componentCase camel`
2325
will create a function component `<FunctionComponent />` in `src/component/profile` including test and story files
2426

2527
![screen recording](http://g.recordit.co/XMuQeSSrgy.gif)

0 commit comments

Comments
 (0)