fix: 🐛 add readme.md

Author: f3ltron

Diff for: lerna.json

@@ -15,5 +15,5 @@
   ],
   "useWorkspaces": true,
   "npmClient": "yarn",
-  "version": "1.2.3"
+  "version": "1.2.4"
 }

Diff for: package.json

@@ -1,6 +1,6 @@
 {
   "name": "vuepres-plugin-docgen",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "description": "vuepress, component doc generation",
   "repository": "https://github.com/f3ltron/vuepress-plugin-docgen",
   "author": "f3ltron",
@@ -28,14 +28,6 @@
   "bugs": {
     "url": "https://github.com/f3ltron/vuepress-plugin-docgen/issues"
   },
-  "husky": {
-    "hooks": {
-      "commit-msg": "[[ -n $HUSKY_BYPASS ]] || commitlint -E HUSKY_GIT_PARAMS"
-      }
-    },
-    "commitlint": {
-      "extends": ["@commitlint/config-conventional"]
-    },
   "homepage": "https://f3ltron.github.io/vuepress-plugin-docgen/",
   "devDependencies": {
     "@commitlint/cli": "^8.0.0",

Diff for: packages/vuepress-plugin-docgen/.npmignore

@@ -1,2 +1 @@
-test
 node_modules

Diff for: packages/vuepress-plugin-docgen/readme.md

@@ -0,0 +1,30 @@
+[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+[![Build Status](https://travis-ci.com/f3ltron/vuepress-plugin-docgen.svg?branch=master)](https://travis-ci.com/f3ltron/vuepress-plugin-docgen)
+
+# vuepress-plugin-docgen
+
+> Vuepress plugin for creating a documentation site of your Vue components
+
+## fast installation
+
+  `yarn add -D vuepress-plugin-docgen`
+
+
+vuepress config file
+
+```jsx
+plugins: [
+  [ 'docgen',
+    {
+      componentsDir: path.join(__dirname, '../../components')
+    }
+  ]
+]
+```
+
+## documentation more infos [click here](https://f3ltron.github.io/vuepress-plugin-docgen/)
+
+## License
+
+MIT © f3ltron