Skip to content

Commit 397709c

Browse files
authored
docs: Add yarn to README and hint to react-styleguidist
1 parent e721493 commit 397709c

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,22 @@ It provides a default implementation for React components defined via
99
(stateless components). These component definitions must follow certain
1010
guidelines in order to be analyzable (see below for more info).
1111

12+
> react-docgen is a low level tool to extract information about react components. If you are searching for a more high level tool try https://github.com/styleguidist/react-styleguidist which comes with a complete styleguide and is build on top of react-docgen.
13+
1214
## Install
1315

14-
Install the module directly from npm:
16+
Install the module with yarn or npm:
17+
18+
```
19+
yarn add react-docgen --dev
20+
```
1521

1622
```
17-
npm install -g react-docgen
23+
npm install react-docgen
1824
```
1925

26+
27+
2028
## CLI
2129

2230
Installing the module adds a `react-docgen` executable which allows you to convert

0 commit comments

Comments
 (0)