Add default usage to README

README.md

@@ -32,10 +32,12 @@ typed(MyComponent, {
  },
  fruitCount: {
  type: typed.number,
+ default: 0,
  description: 'The number of fruit eaten'
  },
  fruit: {
  type: typed.oneOf(['bananas', 'mangoes']),
+ default: 'bananas',
  description: 'The number of fruit eaten'
  },
 })
@@ -54,15 +56,31 @@ console.log(MyComponent.types)
  },
  fruitCount: {
  type: 'number',
+ default: 0,
  description: 'The number of fruit eaten'
  },
  fruit: {
  type: { name: 'oneOf', params: ['bananas', 'mangoes'] },
+ default: 'bananas',
  description: 'The number of fruit eaten'
  },
  }
 */
 ```
+and your installed version of [prop-types][1] is applied
+
+```js
+MyComponent.propTypes = {
+ name: PropTypes.string.isRequired,
+ fruitCount: PropTypes.number,
+ fruit: PropTypes.oneOf(['bananas', 'mangoes'])
+}
+
+MyComponent.defaultProps = {
+ fruitCount: 0,
+ fruit: 'bananas'
+}
+```
 
 ### WHY?
 PropTypes is great for regular use but when building components that need to be documented, it

package.json

@@ -1,7 +1,7 @@
 {
  "name": "typable-react",
- "version": "0.0.3",
- "description": "React.js prop-types wrapper for easy extraction",
+ "version": "0.0.4",
+ "description": "React.js prop-types wrapper for easy extraction to documentation",
  "main": "typable.js",
  "scripts": {
  "test": "jest"
@@ -13,7 +13,10 @@
  "keywords": [
  "static",
  "typed",
- "prop-types"
+ "prop-types",
+ "react",
+ "extract",
+ "documentation"
  ],
  "author": "Joseph Rex",
  "license": "MIT",

publish.sh

@@ -1,11 +1,11 @@
 # Usage:
 # publish 1.2 "my publish message"
 
-npm run build
+# npm run build
 sed -i "" "3s/: .*/: \"$1\",/" package.json
 git add .
 git commit -m "$2"
 git tag -a "v$1" -m "$2"
 git push origin --tags
 git push origin main
-npm publish
+# npm publish