{"_id":"@alfheim/generator-nef-readme","_rev":"5-54687e1377979cbaa444f62a7e17387e","name":"@alfheim/generator-nef-readme","dist-tags":{"latest":"0.3.2"},"versions":{"0.1.0":{"name":"@alfheim/generator-nef-readme","version":"0.1.0","description":"Yeoman generator for basic NEF component readme","repository":{"type":"git","url":"git+https://github.com/Nasdaq/alfheim.git"},"author":{"name":"Haldun Anil"},"license":"MIT","keywords":["yeoman-generator"],"dependencies":{"yeoman-generator":"^4.0.1"},"bugs":{"url":"https://github.com/Nasdaq/alfheim/issues"},"homepage":"https://github.com/Nasdaq/alfheim#readme","_id":"@alfheim/generator-nef-readme@0.1.0","_npmVersion":"6.4.1","_nodeVersion":"10.15.1","_npmUser":{"name":"haldunanil","email":"info@haldunanil.com"},"dist":{"integrity":"sha512-KZRwvIFZqVjmZcg4MvEj4VsWQDnDeJ3mEG246TyMOg2Ry5+d+tcygsBeY7Q2yqE0F0GaEOk+D1W4iS3b7tAUeg==","shasum":"9090e00bfc3692322c721e305d8652dcb172a0eb","tarball":"https://registry.npmjs.org/@alfheim/generator-nef-readme/-/generator-nef-readme-0.1.0.tgz","fileCount":4,"unpackedSize":3091,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdEU65CRA9TVsSAnZWagAAW7gP/RZ9xJmwNoe4gxEByHp6\nmxGki7t7QV94IEArr5ZFrtVEgU1zBAZYaulKW8MAQbB6AGbD1A1cRTaWnOyA\nfKghnaq5agidibY1h8AkeILQTbd0hXDec1e2hYfZOyrBZjOMCdifLR1niU+h\nlC2eNKYm/L020y1tfwErW6ngLtLcY7r1nwDyb17QtLfqCJnkZZbw66FLgOvO\nBA3hDfEj/i5E5V0dNKnZL5DZm1eT0gv7ffu5PRviUOi1EEKCBK3/zloC226i\nr83nTAqCbZA4in+ifvGnegM9dItcA/vrSEayjfBcEuq/07K4Q6r0M9oSBHF3\n4k0xZv0DF3gCUHdyVEjAmDZ8AvBsEb4Zh6MEa5h7P/mGepAE5LX4K2fIcp+j\n2RK3GLwmu6eh7/Vw3hsvvQlCyXQf3Ehj88EoviSAdar7/vDRQHsFOjd3xk/l\nNHHCUfJkT6mp2M94IGKfgQp60dECUhdiZMUmFDX3iinwmgDXgDIp5bw0DIE/\nIpr9CVX+O0NDfB+0Nql3JDpZu3l2FrWJVFxsHC8oIN2aEy3GADiS5wbifwmu\nbEzXsbb7yoY4lUM0OavlOEck8SeCVpR4GMcaEQLzPj+Hu8bk3nEPP3/gxRyX\nShsN/GjhRqN+O1iFsTp8IL8/2RNegAKB7WxXT/6qHZ+J/S4g3RHums/TzQBs\ngJUy\r\n=RpiG\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFrfzIoN/2EdII4Y2+3OSJbGM8NeSge4kUtK5XLpiLV/AiEArQ8rQ5kKt4FlbhOg5piueoP++26zJqxHTQdcE7OYkkY="}]},"maintainers":[{"name":"haldunanil","email":"info@haldunanil.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/generator-nef-readme_0.1.0_1561415352613_0.9933576661909609"},"_hasShrinkwrap":false},"0.1.1":{"name":"@alfheim/generator-nef-readme","version":"0.1.1","description":"Yeoman generator for basic NEF component readme","homepage":"https://github.com/Nasdaq/alfheim/tree/master/packages/generator-nef-readme","repository":{"type":"git","url":"git+https://github.com/Nasdaq/alfheim.git","directory":"packages/generator-nef-readme"},"author":{"name":"Haldun Anil"},"license":"MIT","keywords":["yeoman-generator"],"dependencies":{"yeoman-generator":"^4.0.1"},"gitHead":"bc305c4dba65489f0a963f261b0dee88ced727d9","bugs":{"url":"https://github.com/Nasdaq/alfheim/issues"},"_id":"@alfheim/generator-nef-readme@0.1.1","_nodeVersion":"10.16.0","_npmVersion":"lerna/3.15.0/node@v10.16.0+x64 (linux)","dist":{"integrity":"sha512-ogGv4Val/oLxcK+S7uusGVZwyiwjuAmeBCt6TtvbJfqJ5u4HbK8Psb5m6xjj8qgTVdvbSJlVHeB3tk3QUrKjJA==","shasum":"b769a73fca56f9da081f718d86830592882d68b7","tarball":"https://registry.npmjs.org/@alfheim/generator-nef-readme/-/generator-nef-readme-0.1.1.tgz","fileCount":5,"unpackedSize":4607,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdE+utCRA9TVsSAnZWagAAQ98P/1juAiwRzk+Sc412Jslq\ntF4rTzvFabiw0uBwzZLC+xmIxfVEQRZ+nrZ9vkbiCEcycUylwr4SxaMAAIlm\n55oJJ5U9+nHPm4DY0kEOFnU92vFjFd292/7zbS3K51IVDRKrNrJBiixITlpC\n8Ea/Ayd6U2X8tNmy+js/9UGBZ9+j6vXINNB4+VaNdVnIpKh5nrQvi54GhXvi\n+Ak0HevUx4TcYt0REC2N1YHMZSEGlbSEibsLutmhbr8+2T1NAk2bN7scNrxS\nR7vRATiZFykFBeXvJklfPIvZlKIpw/rG3ZKTWX6rexJsMQw3Hu/GkmCCos8V\naDLmFxW94Kz+78eh9R3nv3AJe7ZW5QRCULsf89q2RX/StNDO5+hjApDu8izG\nesLAZaVAhCNI/gg28H4ldFyFFtMXoAxych1var+hIE3DwmxVaxs0qgfjdE93\n6N4R/Yq9yvhiVKkaZ+FvptEvEucPMQ005rYzA3npNg3yGoiBRN3SMJqdark2\nPgJCcgrqOThG29EQlS54aEnopCaJWh4Up2FQVKdqhLvS/j3PC4UcyEo2YiP8\ngQbdwV2l1j4ltOiZo52CcC1wJdn8M3nBOM8j2Qo9DHlbzOD7Dc01JKWgYOeK\n2IRemdeD9TRU35//USgj1z/dQNSUj9mLUte+Ct+c85T8QkNGaLHcWf9wpH09\nbo0C\r\n=LcdS\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDp2LxYeCSXoVu9ie5LZIcp/zt8VEQW4l2DiPnuuQklJwIgNQBHumPJ1wrxWuo2srrtnshmwbF2/6c7P31NlIiCHiE="}]},"maintainers":[{"name":"haldunanil","email":"info@haldunanil.com"}],"_npmUser":{"name":"haldunanil","email":"info@haldunanil.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/generator-nef-readme_0.1.1_1561586604997_0.6604794828884446"},"_hasShrinkwrap":false},"0.2.0":{"name":"@alfheim/generator-nef-readme","version":"0.2.0","description":"Yeoman generator for basic NEF component readme","homepage":"https://github.com/Nasdaq/alfheim/tree/master/packages/generator-nef-readme","repository":{"type":"git","url":"git+https://github.com/Nasdaq/alfheim.git","directory":"packages/generator-nef-readme"},"author":{"name":"Haldun Anil"},"license":"MIT","keywords":["yeoman-generator"],"dependencies":{"yeoman-generator":"^4.0.1"},"gitHead":"5255b0c2efa5d4dbe2217babd95cf607371339ce","bugs":{"url":"https://github.com/Nasdaq/alfheim/issues"},"_id":"@alfheim/generator-nef-readme@0.2.0","_nodeVersion":"10.16.3","_npmVersion":"lerna/3.16.4/node@v10.16.3+x64 (linux)","dist":{"integrity":"sha512-E9Zjeny2XitV0RhDvvIwjlXs76gqyBstx5K04zfoPvrfuFS4kts0EQTgAWofW32Tc1cyQ/Um9GSyRKkddMZB1w==","shasum":"238f1853c895bf79ff8412406bbd53c0fc9a435f","tarball":"https://registry.npmjs.org/@alfheim/generator-nef-readme/-/generator-nef-readme-0.2.0.tgz","fileCount":5,"unpackedSize":5079,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdW2MhCRA9TVsSAnZWagAAx5YP/jSGO2rLj4BAEPMuVbgp\nTeJAQPXNn40OoGQG+qiK3WDOyF2Y5RTC2Jn4+TtrQBmJplwXgWPDb7RRrzmf\n8wproNIzRXB6ZD12O/eGJ25kuSWCwa3TyJc78pq0mYgnxLby4OT1fqpvGy8h\n2PSuVEA2Q8klh9TuPoN1jABzoWIUu5od0mko1fN9iE74Oyhm9OoSsRm2+0dc\njGJ6U+7gHHA6nMHjPY+Qxyl9CLzOwvGu0ARzkYJTqGlJjVcHZ8r/hKnD0WcM\ndPjQ8tRHmwmgmvIo8jJrhpDD35B7MVBElyhdq79ye7DTtu+0NHjIepgPwQJL\nqYbPTMdLlDN2ZRW1kK/uqDWZcY4AtpHmNjZ3EK0iqN0ryVYDewvnkjQGRLf+\nqeCo/Yp7joLRDXlQlzDgUv7q9SSYBGgabDkg7YoU2wwUlu0MBqYYFFWUWQ4b\ncKFtqAfEYsK047SHo0h4coWBjsBOjLQF41s7ENic4bbwMV/vR8+PA4ESvUHm\nTbJbqIiFN/cj82yg8M3dKTSfyjupj5qBzAVfTQGmLkmF4K8irUahkcv4lgux\nePRq6ymh+J/J3XAhYEBjfxzsl1zKpGc1xljRqxw22569ZjxhhV3pkMrQP7Xw\naDHHWzSrdSywULzb0M6+RyOj4Ge/0P9Oai2oY6hUZREGp/2UIsWVODX4vmu0\ntWVY\r\n=kyqH\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCetqxvZT5hw1/cNm3D5tgjqH0x4XiZQHxAuPhac+HdFgIhAP4ina5rMXljiS6bWyS33r37BOeyIvJ7JHvuJwyTuTli"}]},"maintainers":[{"name":"haldunanil","email":"info@haldunanil.com"}],"_npmUser":{"name":"haldunanil","email":"info@haldunanil.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/generator-nef-readme_0.2.0_1566270240718_0.3418235475718663"},"_hasShrinkwrap":false},"0.2.1":{"name":"@alfheim/generator-nef-readme","version":"0.2.1","description":"Yeoman generator for basic NEF component readme","homepage":"https://github.com/Nasdaq/alfheim/tree/master/packages/generator-nef-readme","repository":{"type":"git","url":"git+https://github.com/Nasdaq/alfheim.git","directory":"packages/generator-nef-readme"},"author":{"name":"Haldun Anil"},"license":"MIT","keywords":["yeoman-generator"],"dependencies":{"yeoman-generator":"^4.0.1"},"gitHead":"8c3040aba0eee3c34ed887e51c62c04f906c04fe","bugs":{"url":"https://github.com/Nasdaq/alfheim/issues"},"_id":"@alfheim/generator-nef-readme@0.2.1","_nodeVersion":"10.16.3","_npmVersion":"lerna/3.16.4/node@v10.16.3+x64 (linux)","dist":{"integrity":"sha512-UKkivw7R4j3gWZhS2xMrdN5LuDDs5N2vbwPUQWIsO1kVnqmf5ZHRMWDpl53TUHROVglDFBovAfmf5DwVPycqnQ==","shasum":"5a5eaa92355d95da0a564a53a5a8d1ef0fc4b680","tarball":"https://registry.npmjs.org/@alfheim/generator-nef-readme/-/generator-nef-readme-0.2.1.tgz","fileCount":6,"unpackedSize":8413,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdX/6jCRA9TVsSAnZWagAApyQP/jCJApyU/WP5v2Nnut9M\n0A6d62SZMc45Gsv/xfN6uTVjBQwF48H4ypcSQaauGouAEhDWgF5gn0dYBJt4\n5EUlxdarmu8ei/gHfpGfj7PIsnpPovqSfKnEr9pFXIrFmC9uAKCsx9ufO+/m\n1mHtoOpu00saN3XrSQKJGmAn6fqNNGXisJ3EWNqvhGD5zGHq5z5PGYH3p9ns\nWEgelX+zuemlJFaOWjc/tdqjTtTxrRJn16XzGhg7ZN2PQWnM+QYki3PjieX4\nZy9XmyQY9PkLghAfiJQ0x3yytPWTk2CW6Hzxeb9cI/WCDROgDnIGaq064Uh1\nt5mL2+9M2ZUqojACKNUivxJBtYgVTH8EfEeDCb33Np8ZY1kbProsh9dgpO05\ndImIe73nVECDTcNbbFKMXT9m52l1ZuBXESVcMdzfGrXi9VhLGQQE3x5FVHB0\nKpVrh1whKEI1mERXciDBrsRsTkH69tDTbaNx6Ab5O0d/pL6Ae3Er5O01otp0\nS5ktfL9GHn5Vxr6WNqegcyIZH6Fgi+wAJ9HgwF/ivq0d9dQKmCKbLhldo6Vv\nkNSJas+hMbuX2cftiaZ8iiJAVpEr5eJau++iJrbg5nRI8ooND386Qv5susie\ntcgbt3Z84RtmAME6l/g9aohF7fe4S5/pDqZPS5v65XvkcUkuARsOVNIZqIiK\nDGyo\r\n=bsZd\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCSWopuo56FWrVYOx+/CzVAMWc2Ch3nIgHslDwC9BgNOgIhAOfWb2ZxPhQQjriObhHtoAa3jHvVsaZZWr7voTd/Pq4k"}]},"maintainers":[{"name":"haldunanil","email":"info@haldunanil.com"}],"_npmUser":{"name":"haldunanil","email":"info@haldunanil.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/generator-nef-readme_0.2.1_1566572194729_0.6678425545576234"},"_hasShrinkwrap":false},"0.3.2":{"name":"@alfheim/generator-nef-readme","version":"0.3.2","description":"Yeoman generator for basic NEF component readme","homepage":"https://github.com/Nasdaq/alfheim/tree/master/packages/generator-nef-readme","repository":{"type":"git","url":"git+https://github.com/Nasdaq/alfheim.git","directory":"packages/generator-nef-readme"},"author":{"name":"Haldun Anil"},"license":"MIT","keywords":["yeoman-generator"],"dependencies":{"yeoman-generator":"^4.0.1"},"gitHead":"f6487d39b53fbb9ae9bd5f7b629c5754889b40db","bugs":{"url":"https://github.com/Nasdaq/alfheim/issues"},"_id":"@alfheim/generator-nef-readme@0.3.2","_nodeVersion":"10.15.1","_npmVersion":"lerna/3.16.4/node@v10.15.1+x64 (darwin)","dist":{"integrity":"sha512-6MkeQFlNatb0oVodG8GYcIPdgVj2yVOWxCGlr+xSSGuJwZrO0nYrgklVtzFlScZ6LZl9AyIi7xLeszEzU6gtBQ==","shasum":"2a26334e6b41e25514b81371ae50a26c8eea3a9a","tarball":"https://registry.npmjs.org/@alfheim/generator-nef-readme/-/generator-nef-readme-0.3.2.tgz","fileCount":6,"unpackedSize":9131,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeTcQ5CRA9TVsSAnZWagAAHhgP/1ay2WjT7BGUP69haiv7\n3Ro/erQeYHBwamL6+jEhEGuVmhVSoLHp9c9UkUmVCQHqNEo8qO/19UsLDZnM\nIVgvxA4KXNSGC4/+mTHx46sBv3Lhl+L0RS0wvXAx8Qra91C6yMt7trOb1Rt4\nBi3OF/XZtGWI7nAT5kZSjN4gcnm49JR7WOSY/XqAg1+rzvxp74m2vEmhsLK3\nyNYDGbz4xd61nZgjRHnj6uZW1urF3nUAU/l0pBJ+5KwHe+kiwVW3Gd2DHOhx\nQsM4N9BYY03o9F2UZXFyY3Es30h9DOiwPU/VAopIvtaYk2hq/1e7X5P3lDJu\n4IbxxdefCZ1sAx2gnjWh3/PeYJzWthrNvTgkqZDkLl45kUicqYgm18E2cI6n\nPCQlSTFqSG/ExUSZy02NVbo8+TP/dVoJGFxB1s7WVMMvpkwiocCtIg6ZoAGJ\nmBlTv7nmA0LpMhxw+BJAcWL/tgLtAQ/ANxv4hKvrrrHFVp6vU+84LMhPjPpK\n2UAyfvhw7mqalXsEkd1kIIPYUwsalSgSr1y+VsUqzrMmhgz/8aLdj38K+SJU\nvwAd3vo15lkBj/7AxkdiLQpnrzGaiOuOVzUaDFGfjZagztaNCS6uukxPPoez\nhgGdPc74NAu2inKcvQwA5wf7kyP+N7ROoZU5LLkQmHoAwjyq6XJVJTj/BlBQ\nGM2W\r\n=WgWW\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC5JiLdd2gzOH8KoWh4PpneWbbG0jZy/+gxc+QD6l0WJwIhAP8FwrPMOfhzTBel7JNWEonhm6VPXR0w0cyDK3OY79s0"}]},"maintainers":[{"name":"haldunanil","email":"info@haldunanil.com"}],"_npmUser":{"name":"haldunanil","email":"info@haldunanil.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/generator-nef-readme_0.3.2_1582154808812_0.6055656879754965"},"_hasShrinkwrap":false}},"time":{"created":"2019-06-24T22:29:12.413Z","0.1.0":"2019-06-24T22:29:12.725Z","modified":"2022-04-04T12:49:05.742Z","0.1.1":"2019-06-26T22:03:25.140Z","0.2.0":"2019-08-20T03:04:00.866Z","0.2.1":"2019-08-23T14:56:34.868Z","0.3.2":"2020-02-19T23:26:48.928Z"},"maintainers":[{"name":"haldunanil","email":"info@haldunanil.com"}],"description":"Yeoman generator for basic NEF component readme","homepage":"https://github.com/Nasdaq/alfheim/tree/master/packages/generator-nef-readme","keywords":["yeoman-generator"],"repository":{"type":"git","url":"git+https://github.com/Nasdaq/alfheim.git","directory":"packages/generator-nef-readme"},"author":{"name":"Haldun Anil"},"bugs":{"url":"https://github.com/Nasdaq/alfheim/issues"},"license":"MIT","readme":"# `@alfheim/generator-nef-readme`\n\n<p>\n  <a href=\"https://travis-ci.org/Nasdaq/alfheim\">\n    <img alt=\"Travis\" src=\"https://img.shields.io/travis/Nasdaq/alfheim/master.svg\">\n  </a>\n  <a href=\"https://www.npmjs.com/package/@alfheim/generator-nef-readme\">\n    <img alt=\"npm (scoped with tag)\" src=\"https://img.shields.io/npm/v/@alfheim/generator-nef-readme/latest\">\n  </a>\n  <a href=\"https://github.com/Nasdaq/alfheim/blob/master/LICENSE\">\n    <img alt=\"GitHub license\" src=\"https://img.shields.io/badge/license-MIT-blue.svg\">\n  </a>\n  <a href=\"https://github.com/Nasdaq/alfheim/pulls\">\n    <img alt=\"PRs welcome\" src=\"https://img.shields.io/badge/PRs-welcome-green.svg\" />\n  </a>\n</p>\n\nThis package is part of the battery used to create new components for the Nasdaq Experience Framework. This package creates an `README.md` file, which provides documentation for the component. \n\n> _Note: It is recommended that you install and use [`generator-nef-component`](https://github.com/Nasdaq/alfheim/tree/9-add-readme-file/packages/generator-nef-component) rather than installing this package directly, unless you need to modify the individual file generators._\n\nA README file created for a component named `Test` using this generator looks as follows:\n\n⚠️ ⚠️ ⚠️ *BEGIN README HERE* ⚠️ ⚠️ ⚠️\n\n# Test\n\n<!-- STORY -->\n\n## Introduction\n\n`Test` is an easy-to-use component.\n\n## Usage\n\n```javascript\nimport { Test } from \"@nef/core\";\n```\n\n## Example use\n\nSee `Story` tab on the right.\n\n## Properties\n\n| propName            | propType                           | defaultValue | isRequired | Description                                        |\n| ------------------- | ---------------------------------- | ------------ | ---------- | -------------------------------------------------- |\n| `className`         | string                             | -            | -          | is the class name of the component                 |\n| `children`          | oneOfType( node, arrayOf( node ) ) | -            | -          | is the children to be passed into component        |\n| `style`             | object                             | -            | -          | is the style object to be passed into component    |\n| `name`              | string                             | -            | -          | id to be passed to the DOM                         |\n| `id`                | string                             | -            | -          | name to be passed to the DOM                       |\n\n⚠️ ⚠️ ⚠️ *END README HERE* ⚠️ ⚠️ ⚠️\n\n## Getting started\n\nTo install, simply run:\n\n```\nyarn add @alfheim/generator-nef-readme --dev\n```\n\nor\n\n```\nnpm install @alfheim/generator-nef-readme --dev \n```\n\n## Contributing\n\nWe'd love to have your helping hand on `alfheim`! Go over to our [issues](https://github.com/Nasdaq/alfheim/issues) section and see if there's anything we're looking for help with OR [open up a PR](https://github.com/Nasdaq/alfheim/pulls) if you have an idea for a way to improve the library.\n\n## License\n\n`Alfheim` is open source software [licensed as MIT](LICENSE).\n","readmeFilename":"README.md"}