You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-2Lines changed: 10 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,14 +9,22 @@ It provides a default implementation for React components defined via
9
9
(stateless components). These component definitions must follow certain
10
10
guidelines in order to be analyzable (see below for more info).
11
11
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
+
12
14
## Install
13
15
14
-
Install the module directly from npm:
16
+
Install the module with yarn or npm:
17
+
18
+
```
19
+
yarn add react-docgen --dev
20
+
```
15
21
16
22
```
17
-
npm install -g react-docgen
23
+
npm install react-docgen
18
24
```
19
25
26
+
27
+
20
28
## CLI
21
29
22
30
Installing the module adds a `react-docgen` executable which allows you to convert
0 commit comments