Skip to content

Commit 64571f8

Browse files
Update readme.md
1 parent d1ef803 commit 64571f8

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

readme.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,11 @@
1-
# Extract react types mono repo
1+
# Extract React Types
22

33
> One stop shop to document your react components.
44
55
<p align="center">
66
<img width="500" src="./assets/example.png">
77
</p>
88

9-
Packages:
10-
11-
1. [extract-react-types](./packages/extract-react-types) _Extract Flow & TypeScript types from React Components_
12-
2. [extract-react-types-loader](./packages/extract-react-types-loader) _Webpack loader for extract-react-types_
13-
3. [babel-plugin-extract-react-types](./packages/babel-plugin-extract-react-types) _A Babel plugin to store the types of React components as a property on the component for documentation_
14-
4. [kind2string](./packages/kind2string) _kind2string is designed to take the data structures output by extract-react-types and convert it down to a (useful) string._
15-
5. [pretty-proptypes](./packages/pretty-proptypes) _PrettyPropTypes is designed to display the output of extract-react-types and display rich prop information for consumers._
16-
179
## Getting started 🏁
1810

1911
### Step 1: Install
@@ -71,6 +63,14 @@ import { Props } from 'pretty-proptypes';
7163

7264
This analyses prop type definitions, and default props. It creates descriptions from comments before the type definitions, and will render markdown syntax using [react-markings](https://www.npmjs.com/package/react-markings).
7365

66+
## Packages
67+
68+
1. [extract-react-types](./packages/extract-react-types) _Extract Flow & TypeScript types from React Components_
69+
2. [extract-react-types-loader](./packages/extract-react-types-loader) _Webpack loader for extract-react-types_
70+
3. [babel-plugin-extract-react-types](./packages/babel-plugin-extract-react-types) _A Babel plugin to store the types of React components as a property on the component for documentation_
71+
4. [kind2string](./packages/kind2string) _kind2string is designed to take the data structures output by extract-react-types and convert it down to a (useful) string._
72+
5. [pretty-proptypes](./packages/pretty-proptypes) _PrettyPropTypes is designed to display the output of extract-react-types and display rich prop information for consumers._
73+
7474
## Contribute
7575

7676
Pull requests, issues and comments welcome - please read our [contributing guidelines](./contributing.md) and our [code of conduct](./code-of-conduct.md).

0 commit comments

Comments
 (0)