{"_id":"@appbaseio/storybook-readme","_rev":"4-c855e077b3ad48ca0c99e578775517d4","name":"@appbaseio/storybook-readme","dist-tags":{"latest":"5.0.12"},"versions":{"5.0.9":{"name":"@appbaseio/storybook-readme","license":"MIT","private":false,"version":"5.0.9","description":"Storybook addon to show components README (for React and Vue)","main":"index.js","homepage":"https://github.com/tuchk4/storybook-readme","bugs":{"url":"https://github.com/tuchk4/storybook-readme/issues"},"repository":{"type":"git","url":"git+https://github.com/tuchk4/storybook-readme.git"},"dependencies":{"@storybook/components":"^5.0.6","@storybook/core-events":"^5.0.6","html-loader":"^0.5.5","lodash":"^4.17.11","markdown-loader":"^5.0.0","marked":"^0.7.0","node-emoji":"1.10.0","prism-themes":"^1.1.0","prismjs":"^1.16.0","react-element-to-jsx-string":"^14.0.2","string-raw":"^1.0.1","vuex":"^3.1.0"},"devDependencies":{"@babel/cli":"7.2.3","@babel/core":"7.3.4","@storybook/addons":"^5.0.6","babel-preset-react-app":"^7.0.1","cross-env":"^5.1.3"},"scripts":{"prepublish":"npm run clear & cross-env NODE_ENV=production babel -d ./ ./src","dev":"npm run clear & cross-env NODE_ENV=production babel -d ./ ./src --watch","clear":"ls ./src | xargs rm -rf"},"keywords":["storybook","react-storybook","docs","readme"],"author":{"name":"valeriy.sorokobatko@gmail.com"},"gitHead":"5d5d1734019e8493480892effa60e390f3e926f2","_id":"@appbaseio/storybook-readme@5.0.9","_nodeVersion":"16.16.0","_npmVersion":"8.11.0","dist":{"integrity":"sha512-1Vw8+z4sN3XEV3MA1E28D69e4ptwiBc6USrslb8W7rlV5lgYEDqB/HP7Gfcd72C+Xh8EIsdTbEWGfsqIAnfvow==","shasum":"040d389aa87ffa4436a3aa1bc4198e22993edbfc","tarball":"https://registry.npmjs.org/@appbaseio/storybook-readme/-/storybook-readme-5.0.9.tgz","fileCount":3,"unpackedSize":10340,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIA5AtTYjvQ1Sc39zii1RZ632bob3sy8qt/YBANylSs+tAiAQyIVajq2OrdKPSXAw296Be+/rI66pJhg176exqPLvIg=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjvyWpACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoaTQ/8CqtkPgiSA1swnR87ZZ4Hob/LdO+r7yG1jMEl2O9GpDr+/29K\r\nq+Za6deDXw3wuujMsTNv19jdRpZgVUQmjBEIsuKD6dfSeL1aUBc7upfv1fsa\r\nI79JLDOwiW91gntFjOTLGUz2JXNWMymkNW6B5ntOWfI6jwNwWbihzi9QaxWs\r\n2QDXvyjf1p5gMHz+nAtzZN9/PB+GD3XEQ1jdjfxkORg6cOiWGG12yk1gcqOq\r\n+up9hN+eeU0iU5j23JtKAKxB1nD8qi7/HUuoD6FWIjNcc2WYj/x2KwjY7Vvt\r\nY7h09IHbesLQpwOZ/teoK10XOy8wNIl1LBKwsaFeBuk8IQ55P9/VlIPMgLum\r\ngtj3LcWbUHLBc3QSSMoiNrwrC9MnXYxktLTnVZU30OSTxv9m2RKj9C8C/03c\r\nTNU4rlmyIWczKnPBQ10oWsjxjWmHJCE4JBL1SVxRyhp3vclrp07nez8pWqiu\r\nqRK8iOh+M7DyaAyypS2RUJiSH3QWWrb0rK0TEVE7teQUbLveFYpiRoy1fv/w\r\nDC41HYc3sSqABHTs3InlS4pw7UR2Pv1k3TmLaIld2i5alhHLUovKGyGLNI47\r\nHg+Dpc4RdJQB1CYN1NEQwCGwTB5FwULXsa/Zkw3kIIjAbKZ11diBYwC/rfNP\r\nggsarxkAJsE1M3AaU4Dc6yR4qSjoq4idhDI=\r\n=pq+U\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"anjuma","email":"kuldepsaxena155@gmail.com"},"directories":{},"maintainers":[{"name":"siddharthlatest","email":"siddharth@appbase.io"},{"name":"anjuma","email":"kuldepsaxena155@gmail.com"},{"name":"mohdashraf010897","email":"mohdashraf010897@gmail.com"},{"name":"reactivesearch","email":"info@appbase.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/storybook-readme_5.0.9_1673471401105_0.35491462775090743"},"_hasShrinkwrap":false},"5.0.10":{"name":"@appbaseio/storybook-readme","license":"MIT","private":false,"version":"5.0.10","description":"Storybook addon to show components README (for React and Vue)","main":"index.js","homepage":"https://github.com/tuchk4/storybook-readme","bugs":{"url":"https://github.com/tuchk4/storybook-readme/issues"},"repository":{"type":"git","url":"git+https://github.com/tuchk4/storybook-readme.git"},"dependencies":{"@storybook/components":"^5.0.6","@storybook/core-events":"^5.0.6","html-loader":"^0.5.5","lodash":"^4.17.11","markdown-loader":"^5.0.0","marked":"^0.7.0","node-emoji":"1.10.0","prism-themes":"^1.1.0","prismjs":"^1.16.0","react-element-to-jsx-string":"^14.0.2","string-raw":"^1.0.1","vuex":"^3.1.0"},"devDependencies":{"@babel/cli":"7.2.3","@babel/core":"7.3.4","@storybook/addons":"^5.0.6","babel-preset-react-app":"^7.0.1","cross-env":"^5.1.3"},"scripts":{"prepublish":"npm run clear & cross-env NODE_ENV=production babel -d ./ ./src","dev":"npm run clear & cross-env NODE_ENV=production babel -d ./ ./src --watch","clear":"ls ./src | xargs rm -rf"},"keywords":["storybook","react-storybook","docs","readme"],"author":{"name":"valeriy.sorokobatko@gmail.com"},"gitHead":"5d5d1734019e8493480892effa60e390f3e926f2","_id":"@appbaseio/storybook-readme@5.0.10","_nodeVersion":"16.16.0","_npmVersion":"8.11.0","dist":{"integrity":"sha512-Ht5IgDiVwUXGZbfMuV6HWniOL/BVwfaMQu9D0chTfkBlpxrZokvGpXH+2UJ0h5sbK86meIli5r3N0+phNtjgFw==","shasum":"e1a26a2e2b854fcf1faadd751bda5280f6e22c3c","tarball":"https://registry.npmjs.org/@appbaseio/storybook-readme/-/storybook-readme-5.0.10.tgz","fileCount":3,"unpackedSize":10341,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFpYWCjsaA+Xp8GErnGQ18KUo/1OWbwmQJKfRbkGwIvJAiEAhQUreFsS2NxsklUsnA2nbKrrrLZCFQvCP+9o6w7r0ho="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjvydpACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpytxAAnTNln+bhL64V52OED9R8FU1WxQNWt1uF/Vqj+aBnWxlPXKgC\r\nqPlWvjKZTvRYgwWbxpJ/HrR1YSw0NrdMNg9htHyJFtIfrDrkmDOvPY1ZWUtX\r\nqnLq/bJMZE53wMNRpcQeTS+teBHItQKv075X8GEB8gpdk7Ptp9QVgdNJl1s4\r\n2KnvJKUHk/XdVCln+U3FXc2b4cjiKkf6HzgQzHvep/zjpv2uRVDOy9OdDeFt\r\nyiTLSPp1dHFQsR+7d0BrvyviSRZXUrFJvggSgfhVeQ/79TdU+gy3KH6Axzzs\r\nDEbLf4P7zOmyLN4iY/lOCzy9F9ibgM1bBoGT6quh/vcwesHNaxJVjBbyd5kJ\r\nS1jYzTssHuUOO0IZRlTAIM1LI9K3pO5WchBp7B/FaHvCDXUSsfgLSZV3n5dv\r\nbVSzOyUOSyDVo/kUGsuLG6nN3MMlWZNua2FMNpgJk1sVExzNaE9y3+P8Wk2w\r\nBn8+h2eVgk+/FuoTO1bwcx3m5SObeNFDerWuTGtOMmvhtn+e4ks1CdxKuamn\r\n2JYezH2TAQyZq/E+I+OcbQ5INhG3Ahtr91C7+C90I+VP915lDOtDz/2yYhQK\r\n8+vBureaQUJ8UBlQbfH+0B7OazLVSx4iOLK5Aytce2dkjCdMJkUEnNMe25mz\r\n1QF+FIOPmKF4dSSeWgOKnU65vphN277lXic=\r\n=qhfa\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"anjuma","email":"kuldepsaxena155@gmail.com"},"directories":{},"maintainers":[{"name":"siddharthlatest","email":"siddharth@appbase.io"},{"name":"anjuma","email":"kuldepsaxena155@gmail.com"},{"name":"mohdashraf010897","email":"mohdashraf010897@gmail.com"},{"name":"reactivesearch","email":"info@appbase.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/storybook-readme_5.0.10_1673471849758_0.6376952532671305"},"_hasShrinkwrap":false},"5.0.11":{"name":"@appbaseio/storybook-readme","license":"MIT","private":false,"version":"5.0.11","description":"Storybook addon to show components README (for React and Vue)","main":"index.js","homepage":"https://github.com/tuchk4/storybook-readme","bugs":{"url":"https://github.com/tuchk4/storybook-readme/issues"},"repository":{"type":"git","url":"git+https://github.com/tuchk4/storybook-readme.git"},"dependencies":{"@storybook/components":"^5.0.6","@storybook/core-events":"^5.0.6","html-loader":"^0.5.5","lodash":"^4.17.11","markdown-loader":"^5.0.0","marked":"^0.7.0","node-emoji":"1.10.0","prism-themes":"^1.1.0","prismjs":"^1.16.0","react-element-to-jsx-string":"^14.0.2","string-raw":"^1.0.1","vuex":"^3.1.0"},"devDependencies":{"@babel/cli":"7.2.3","@babel/core":"7.3.4","@storybook/addons":"^5.0.6","babel-preset-react-app":"^7.0.1","cross-env":"^5.1.3"},"scripts":{"build":"npm run clear & cross-env NODE_ENV=production babel -d ./ ./src","prepublish":"npm run clear & cross-env NODE_ENV=production babel -d ./ ./src","dev":"npm run clear & cross-env NODE_ENV=production babel -d ./ ./src --watch","clear":"ls ./src | xargs rm -rf"},"keywords":["storybook","react-storybook","docs","readme"],"author":{"name":"valeriy.sorokobatko@gmail.com"},"gitHead":"5d5d1734019e8493480892effa60e390f3e926f2","_id":"@appbaseio/storybook-readme@5.0.11","_nodeVersion":"16.16.0","_npmVersion":"8.11.0","dist":{"integrity":"sha512-0N2zptQ4XjDhtsUM7c3SSsoFkxFRaVHWMPa0wmZ0n52KrjtXdCyK/56shNJviYjVp/ZKq5podmDTQZul8laPPA==","shasum":"e543e8b6fa06cb9a476cfc9b26eb2ac6b7954210","tarball":"https://registry.npmjs.org/@appbaseio/storybook-readme/-/storybook-readme-5.0.11.tgz","fileCount":149,"unpackedSize":334756,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHRRDe/iKp4d9ljXtvALVJcMqtF/LP1kkhvHiYBNuKWlAiA3xY5A3vekUU6KDAmlWEqh80/vhSswEmD5dZ2pHKLyEQ=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjvy+JACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrMTxAAi3mK5NTKXxNa2jjCdVVz46k0pUz1yphuAubxGC7SGNh9lwzr\r\nDd8A9QExoNOGCl2Sc2it2Gw8e1YMd+S1tTwFiiT8lQ+1zvEizgaroY9AQMwh\r\n3/FvDwUe9TM6eZ6EuKJNLjT4m+lHl+fLGcdwXjm7zkInFLdOYTeDie9BOzex\r\n1HpMwLIBxzpHdawwHIZWlebN7IIv2Av6zqDM5xqTVB1bkcw7xRAEspO5oUaW\r\nknPIp4bctE439yUaAc2t5WjUixYWMsHRpvjPOoj1w5oGQWq656MrlKNi07Co\r\nkG6RD7TsgNqbaDU2KlbmOaJiJhqr6X2EuIQN4+Cs1FJRsE8wpfVMwxPPULC5\r\nxEinEPq7sO+9wVhqLglQCWUz1Lh4tkv5R80IS1tiaTdzaXNo6rSuztdBitYw\r\nkFHTj23R3BryrujsrchUNljUZ5qqP/A7Yk5OqpOubO688dHsXlJMuT69rw93\r\noIcpLJ8kwOEPCzaRCTBVMtDA4GA8GhteT8KrkrKBrBEU6pXEhk2uRgGQioOD\r\nt+dPTKLUFMt73W76r/CTR0luO9ytmiFINY/dTt2WrJDP/RyOxJORzqEsQdlG\r\neovtXS6YGCyShpE7TMeJ461zAyLJzQR1gXX0Mg4F1Qb0m0VrI9nAqDKSFNEa\r\np3yPxvHEk5Qb1C2MGoL+seXDVMyMTdg3HaM=\r\n=uW/M\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"anjuma","email":"kuldepsaxena155@gmail.com"},"directories":{},"maintainers":[{"name":"siddharthlatest","email":"siddharth@appbase.io"},{"name":"anjuma","email":"kuldepsaxena155@gmail.com"},{"name":"mohdashraf010897","email":"mohdashraf010897@gmail.com"},{"name":"reactivesearch","email":"info@appbase.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/storybook-readme_5.0.11_1673473929760_0.8923496671968705"},"_hasShrinkwrap":false},"5.0.12":{"name":"@appbaseio/storybook-readme","license":"MIT","private":false,"version":"5.0.12","description":"Storybook addon to show components README (for React and Vue)","main":"index.js","homepage":"https://github.com/tuchk4/storybook-readme","bugs":{"url":"https://github.com/tuchk4/storybook-readme/issues"},"repository":{"type":"git","url":"git+https://github.com/tuchk4/storybook-readme.git"},"dependencies":{"@storybook/components":"^5.0.6","@storybook/core-events":"^5.0.6","html-loader":"^0.5.5","lodash":"^4.17.11","markdown-loader":"^5.0.0","marked":"^0.7.0","node-emoji":"1.10.0","prism-themes":"^1.1.0","prismjs":"^1.16.0","react-element-to-jsx-string":"^14.0.2","string-raw":"^1.0.1","vuex":"^4.1.0"},"devDependencies":{"@babel/cli":"7.2.3","@babel/core":"7.3.4","@storybook/addons":"^5.0.6","babel-preset-react-app":"^7.0.1","cross-env":"^5.1.3"},"scripts":{"build":"npm run clear & cross-env NODE_ENV=production babel -d ./ ./src","prepublish":"npm run clear & cross-env NODE_ENV=production babel -d ./ ./src","dev":"npm run clear & cross-env NODE_ENV=production babel -d ./ ./src --watch","clear":"ls ./src | xargs rm -rf"},"keywords":["storybook","react-storybook","docs","readme"],"author":{"name":"valeriy.sorokobatko@gmail.com"},"gitHead":"5d5d1734019e8493480892effa60e390f3e926f2","_id":"@appbaseio/storybook-readme@5.0.12","_nodeVersion":"16.16.0","_npmVersion":"8.11.0","dist":{"integrity":"sha512-K6YM1dmJREhaWgPuazBiV4su7LRBEPj4j59jD+zqxcerZvZXHlZxz1L2Stxxlt9nAZchhI9gsk5hSrXCnb9ZCg==","shasum":"d90b37286a6d622825e62a55c084b896fbcf8ee2","tarball":"https://registry.npmjs.org/@appbaseio/storybook-readme/-/storybook-readme-5.0.12.tgz","fileCount":149,"unpackedSize":334731,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCHnTdWovYJRZDEw8C5OqKvO7LUxFki4H+Ng5b+mbBHKwIgCJfmLGYs/g16n7I4Uu3kV3tDKk4EISzD1+gq1Yg78OM="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjvzKkACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoSPxAAi5tw4h9MLAJ6axRA7qXDW92u02i4ZL5puiOCbcAJ00yz1lAH\r\ntQi9E5LrWU+qS4lrUfwUymdiQRLOHK0Rb3eq961VZWyfvoFo0tb60qCR8Puk\r\nEipas8RgRXpOkd0kObyaIpvXb37KyAsmP9FnxWr2SkLiWmA7wqaO9FsPJjkZ\r\nVxT9RmfB4Bt7vaedg6+6RgM1wH6ekpMg9+wzHM3ip+XPR74IJBaiAm3gMxFe\r\n4H+TNHK37GdC+n45gHlrkdWzrChIkESj/HR9e9D+2N+eRJfeFTjEXiDAfZ75\r\nSewOkHBs9iSANsl/fsx6N8Sa2XB847sNFivIZXf35wCy3vwUPqWQzD0ek2Zy\r\nHRl8IhwvTNcOjhjW8dqfLQxIStMtD+Yxj9sBIIm8YMu9obubYpY2aFEStchx\r\nFMxx+xzsbhCvhgY0IVlSETjBIWt35KamT6qp/5czvYab1xm3QiIeyGuy8/Kn\r\nNlrX/91CAnMEQIQEPybpS8oTSFoeB3ND0oQL/raouIUK6ateVWgTEneErTRI\r\nytOLWvC5ND1xEXmzT7XPjhwJXtpHlubYJWcZPFDsSwAmym0UjkF23wqchA1N\r\noRYd7gyn9NN3jBSSvRFJhv/pS9uroXT15ZLNsZM7sZJCoOWF8gGgd932l7zo\r\nwlaBlJnfUxAY6fBgbaxsjOavK3U7KkxRncI=\r\n=tpab\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"anjuma","email":"kuldepsaxena155@gmail.com"},"directories":{},"maintainers":[{"name":"siddharthlatest","email":"siddharth@appbase.io"},{"name":"anjuma","email":"kuldepsaxena155@gmail.com"},{"name":"mohdashraf010897","email":"mohdashraf010897@gmail.com"},{"name":"reactivesearch","email":"info@appbase.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/storybook-readme_5.0.12_1673474724531_0.9737854214763049"},"_hasShrinkwrap":false}},"time":{"created":"2023-01-11T21:10:01.051Z","5.0.9":"2023-01-11T21:10:01.277Z","modified":"2023-04-19T07:30:45.023Z","5.0.10":"2023-01-11T21:17:29.913Z","5.0.11":"2023-01-11T21:52:09.931Z","5.0.12":"2023-01-11T22:05:24.720Z"},"maintainers":[{"email":"shubhamshahrising@gmail.com","name":"savvyshah"},{"email":"siddharth@appbase.io","name":"siddharthlatest"},{"email":"kuldepsaxena155@gmail.com","name":"anjuma"},{"email":"mohdashraf010897@gmail.com","name":"mohdashraf010897"},{"email":"info@appbase.io","name":"reactivesearch"}],"description":"Storybook addon to show components README (for React and Vue)","homepage":"https://github.com/tuchk4/storybook-readme","keywords":["storybook","react-storybook","docs","readme"],"repository":{"type":"git","url":"git+https://github.com/tuchk4/storybook-readme.git"},"author":{"name":"valeriy.sorokobatko@gmail.com"},"bugs":{"url":"https://github.com/tuchk4/storybook-readme/issues"},"license":"MIT","readme":"# Storybook README addon\n\nNOTE: This README only for version `^5.0.0`. For older versions [LEGACY_README.md](./LEGACY_README.md)\n\n---\n\n![Storybook README addon](https://user-images.githubusercontent.com/5140611/54478027-86d38400-4816-11e9-96a0-aecef64e3ea7.png)\n\nThis addon is compatible with:\n\n- Storybook for React ([React example storybook](packages/example-react))\n- Storybook for Vue ([Vue example storybook](packages/example-vue))\n\n[Live demo](https://tuchk4.github.io/storybook-readme)\n\nFeatures:\n\n- Automatically generate props table (Only for React)\n- Does not affect on _story function_. So [Storybook Info](https://github.com/storybooks/storybook/tree/master/addons/info) works correctly now.\n- 100% markdown support\n- Code highlighting\n- Accept multiple README (useful for [hoc component](https://medium.com/@franleplant/react-higher-order-components-in-depth-cf9032ee6c3e) - add component's and original component's README)\n- Looks like Github's README\n- Supports `` tags for vue components ([example-vue/components/MyButton/MyButton.vue](https://github.com/tuchk4/storybook-readme/blob/master/packages/example-vue/components/MyButton/MyButton.vue)).\n\nAlso it very useful because most projects and components already have _README.md_ files. Now it is easy to add them into your Storybook.\n\nStories will be added with _.addWithInfo_ method if [Storybook Info Addon](https://github.com/storybooks/storybook/tree/master/addons/info) is installed.\n\n## Install\n\n`npm install --save-dev storybook-readme`\n\nor\n\n`yarn add --dev storybook-readme`\n\n### Webpack Configuration for React Storybook\n\nNothing to do :)\n\n### Webpack Configuration for Vue Storybook\n\nOnly if using [Single File Components](https://vuejs.org/v2/guide/single-file-components.html) and want to use `` tag at storybook documentation.\n\n```js\nmodule.exports = storybookBaseConfig => {\n storybookBaseConfig.module.rules.push({\n resourceQuery: /blockType=docs/,\n use: ['storybook-readme/vue/docs-loader', 'html-loader', 'markdown-loader'],\n });\n};\n```\n\nDefine `` tag inside vue module:\n\n```vue\n\nDocs inside vue module \n\n\n\n```\n\nUse it to defone docs at story:\n\n```js\nimport MyButton from '../components/MyButton/MyButton.vue';\n\nstoriesOf('Vue ', module).addParameters({\n readme: {\n content: MyButton.__docs,\n },\n});\n```\n\n## Setup\n\nRegister addon at _.storybook/addons.js_\n\n```js\nimport 'storybook-readme/register';\n```\n\nAdd decorator at _.storybook/config.js_\n\n```js\nimport { addReadme } from 'storybook-readme';\naddDecorator(addReadme);\n```\n\n## Usage\n\nHope it is very simple.\n\n```js\nimport React from 'react';\nimport { storiesOf } from '@storybook/react';\n\nimport Button from '../components/Button';\nimport ButtonReadme from '../components/Button/README.md';\n\nstoriesOf('Buttons', module)\n .addDecorator(withKnobs)\n .addParameters({\n readme: {\n // Show readme before story\n content: ButtonReadme,\n // Show readme at the addons panel\n sidebar: ButtonReadme,\n },\n })\n .add('Button', () =>