Merge branch 'master' of github.com:atlassian/extract-react-types

Author: Noviny

LICENSE

@@ -1,4 +1,4 @@
-Copyright 2017 Atlassian Pty Ltd
+Copyright 2017 - present Atlassian Pty Ltd
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

README.md

@@ -1,3 +1,58 @@
 # extract-react-types
 
 > Extract Flow & TypeScript types from React Components
+
+## Features
+
+- Supports flow and typescript
+- Extracts the description of the props too ( Great for documentation )
+
+## Usage
+
+```sh
+$ yarn add extract-react-types
+```
+
+```js
+// Component.js
+
+class Component extends React.Component<{ foo: boolean }> {}
+```
+
+Output:
+
+```js
+{
+  "kind": "program",
+  "classes": [
+    {
+      "kind": "object",
+      "members": [
+      {
+        "kind": "property",
+        "key": {
+        "kind": "id",
+        "name": "foo"
+        },
+        "value": {
+        "kind": "boolean"
+        },
+        "optional": false
+      }
+      ],
+      "name": {
+      "kind": "id",
+      "name": "Component",
+      "type": null
+      }
+    }
+  ]
+}
+```
+
+## Related projects:
+
+- [extract-react-types-loader](https://www.npmjs.com/package/extract-react-types-loader)
+- [pretty-proptypes](https://github.com/Noviny/pretty-proptypes)
+- [kind2string](https://github.com/gwyneplaine/kind2string)
+

package.json

@@ -8,6 +8,13 @@
   "scripts": {
     "test": "jest"
   },
+  "keywords": [
+    "react",
+    "flow",
+    "typescript",
+    "prop-types",
+    "documentation"
+  ],
   "dependencies": {
     "@babel/core": "7.0.0-beta.56",
     "@babel/types": "^7.0.0-beta.56",