{"bin":{"solidity-docgen":"./dist/cli.js"},"dist":{"shasum":"8f193a8fcba2de37c1ca2444b5860ed382267956","tarball":"https://registry.npmjs.org/solidity-docgen/-/solidity-docgen-0.2.0-alpha.1.tgz","fileCount":20,"integrity":"sha512-MTfD8zJ9+0JK8a80vXSubVsya/v2jlFdwJ0XfnC8NYp0AaIdGe7M6ngVmyfCemWX3eISFVzMFaVdYmPcA56cLQ==","signatures":[{"sig":"MEYCIQDiKcAlwiuUxxYkion2gL0nJoAWHpV319p0w/cYIGDdHwIhAISRyCAl587hqiWfNaGnOMXXyEBcEjCpSMtGlWtNWrDW","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":37946,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJc5Vd0CRA9TVsSAnZWagAAl3YP/2ta4D7tYqEIf/OUTjvl\nZZiCb2xeZlFKZDasACYFfBVSmU7X39yTOwqsBHgObF+/EWE9SyND7hCXIWjO\nl01ndKx45X1LeP4Aibt7VhXB/CkIEaw/KgQDP2jXZU46IjnRhNUJx8jQZyvg\nn0WghyMKn5QojG3tzs/KJLn2KtCFOwuNp23e40ukt20Hz675X2eJtjp4xyRR\n400+vc6OWpjadAxRMTxAaT4fsFJlFtWooSdjyBJDOMRGxmlKvTmtUvNBmeBU\nlrd9vJmHmc4oob6I6+FMi+DDt4pJMJOVgsFTP7cPluWk8DBctjI5HmqEQA5T\nciqYics0vqKxUgb55AwYnf5WT8Pp3D7+PGMh1U74L5o/OohVJzYLuvnV+RG1\ntM/W9NON40ZzsH0hr2/U//qX0/tkzeLUkqjGG45DVHUrb7/hinsh2Zg0ol+T\nHr1EdXw3XkY502iPCOHtvlA4ikrXssKpf7nio67GDotYtV1hR+6vkzDBD1II\nOf4fDYXa5NFrcsqUQiz5PZIaaij71alpR7lcr5fv6VOuvFlfuL5mHg0Z/Mcu\nsNY+Hcj66ukbhdr0Z131HJGCb9PnC1UaDqRy+9K5hIRpdKSH5upotQLUXCCl\nDnwVp45p6mIr1j2IAlzno0uJJjtTO6kKKIFkNxxabTHukmxo0yvXvG+VrAEb\n4gVc\r\n=osAa\r\n-----END PGP SIGNATURE-----\r\n"},"name":"solidity-docgen","author":{"name":"spalladino@gmail.com"},"readme":"# `solidity-docgen` (WIP)\n\n**Documentation generator for libraries of smart contracts.**\n\n`solidity-docgen` combines inline documentation with long form documents to\ngenerate documentation pages that can be easily made into a static site.\n\nUsed to generate the documentation for OpenZeppelin.\n\n## Install\n\n```sh\nnpm install solidity-docgen\n```\n\n## Usage\n\n1. Document your source code in inline comments using `@dev` tags in the [NatSpec] format.\n2. Write longer form documentation in a README.md file next to your smart contracts. (Optional)\n3. Run `npx solidity-docgen` at the root of your project to generate documentation pages in the `docs/` directory.\n4. Serve the documentation using a static site generator.\n\n[NatSpec]: https://solidity.readthedocs.io/en/develop/natspec-format.html\n","gitHead":"c5c29eb623b5c62cbe8d4e39dfc843f1583d445b","license":"MIT","scripts":{"test":"jest","build":"babel --out-dir dist src","prepare":"npm run build","test:watch":"jest --watch"},"_npmUser":{"name":"frangio","email":"frangio.1@gmail.com"},"keywords":["solidity","api","documentation","automatic","generator"],"_npmVersion":"6.9.0","description":"Solidity API documentation automatic generator.","directories":{},"maintainers":[{"name":"spalladino","email":"spalladino@gmail.com"}],"_nodeVersion":"11.15.0","contributors":[{"url":"http://ealmansi.github.io/","name":"Emilio Almansi","email":"ealmansi@gmail.com"}],"dependencies":{"glob":"^7.1.3","solc":"^0.5.4","react":"^16.8.3","lodash":"^4.17.11","js-yaml":"^3.12.2","commander":"^2.14.1","react-dom":"^16.8.3"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"jest":"^24.1.0","@babel/cli":"^7.2.3","@babel/core":"^7.2.2","@babel/register":"^7.0.0","@babel/preset-env":"^7.3.1","@babel/preset-react":"^7.0.0","react-test-renderer":"^16.8.1","@babel/plugin-proposal-object-rest-spread":"^7.4.0"},"_npmOperationalInternal":{"tmp":"tmp/solidity-docgen_0.2.0-alpha.1_1558534002763_0.9243104340282529","host":"s3://npm-registry-packages"},"_id":"solidity-docgen@0.2.0-alpha.1","version":"0.2.0-alpha.1"}