{"_id":"@ayobami6/readme-generate","_rev":"2-ad9444e7b05f906a008907abfe69bb75","name":"@ayobami6/readme-generate","dist-tags":{"latest":"1.1.1"},"versions":{"1.0.0":{"name":"@ayobami6/readme-generate","version":"1.0.0","description":"Generate a detialed readme with AI","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"type":"module","devDependencies":{"eslint":"^8.46.0","eslint-config-airbnb-base":"^15.0.0","eslint-plugin-import":"^2.28.0"},"bin":{"readme-generate":"index.js"},"dependencies":{"dotenv":"^16.3.1","openai":"^3.3.0"},"keywords":["readme","generate","ai","openai","openai-api","cli","command-line"],"author":{"name":"Ayobami Alaran"},"license":"MIT","_id":"@ayobami6/readme-generate@1.0.0","_nodeVersion":"20.3.1","_npmVersion":"9.6.7","dist":{"integrity":"sha512-k23++tbwrtWbPOjaNLv1CVjwUVmV0pIChphDkbPDumMVC7c05luKI/53EHU5P5sB4T0FLrtr+IILEMDIrHazVQ==","shasum":"ed3f5c690a0ec9079780cd72478c9f3214369642","tarball":"https://registry.npmjs.org/@ayobami6/readme-generate/-/readme-generate-1.0.0.tgz","fileCount":3,"unpackedSize":2382,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDck5dzRzw10phGo8q/r3fNR64ibDiRmJKP64FUIZu4KgIgO/bZGCH467f4usH3KmSqwLpt/3WvkPsEHqqZHYtDwBU="}]},"_npmUser":{"name":"ayobami6","email":"ayobamidele006@gmail.com"},"directories":{},"maintainers":[{"name":"ayobami6","email":"ayobamidele006@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/readme-generate_1.0.0_1690630266956_0.1962674531620887"},"_hasShrinkwrap":false},"1.1.0":{"name":"@ayobami6/readme-generate","version":"1.1.0","description":"Generate a detialed readme with AI","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"type":"module","devDependencies":{"eslint":"^8.46.0","eslint-config-airbnb-base":"^15.0.0","eslint-plugin-import":"^2.28.0"},"bin":{"readme-generate":"index.js"},"dependencies":{"dotenv":"^16.3.1","openai":"^3.3.0"},"keywords":["readme","generate","ai","openai","openai-api","cli","command-line"],"author":{"name":"Ayobami Alaran"},"license":"MIT","gitHead":"5218289341135177d87dff89119a1ce421ce8b35","_id":"@ayobami6/readme-generate@1.1.0","_nodeVersion":"20.3.1","_npmVersion":"9.6.7","dist":{"integrity":"sha512-4Ln0+2izQ3bchq2Yc5rHMEtPefkEEyrqXkiCfCmftnyrylZkEaTlmpM/aGkVLu4SX27ig26peJMXEAWHYEekJw==","shasum":"75808c7fa0ea515503d223962a45481fd363e99a","tarball":"https://registry.npmjs.org/@ayobami6/readme-generate/-/readme-generate-1.1.0.tgz","fileCount":4,"unpackedSize":2474,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD6hZT/VW5vTznMESZJhWagpi5/cWUTNZjdVlr/lnqLxAIgHlkFf1fdRToJfTaQb93lMilJuPkBA29tVUnwHnMambs="}]},"_npmUser":{"name":"ayobami6","email":"ayobamidele006@gmail.com"},"directories":{},"maintainers":[{"name":"ayobami6","email":"ayobamidele006@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/readme-generate_1.1.0_1690630559136_0.11320615505852949"},"_hasShrinkwrap":false},"1.1.1":{"name":"@ayobami6/readme-generate","version":"1.1.1","description":"Generate a detialed readme with AI","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"type":"module","devDependencies":{"eslint":"^8.46.0","eslint-config-airbnb-base":"^15.0.0","eslint-plugin-import":"^2.28.0"},"bin":{"readme-generate":"index.js"},"dependencies":{"dotenv":"^16.3.1","openai":"^3.3.0"},"keywords":["readme","generate","ai","openai","openai-api","cli","command-line"],"author":{"name":"Ayobami Alaran"},"license":"MIT","gitHead":"adbd2f28456db568efceedf4d95ebac632e7dabc","_id":"@ayobami6/readme-generate@1.1.1","_nodeVersion":"20.3.1","_npmVersion":"9.6.7","dist":{"integrity":"sha512-Ii2e+fBboK6ABvP2NK7KEOz8u6y9FgLR2ajnU1sZgT2nGa6lOzQalqUF1jJceX6R8tbJjsy+wKIZsdi93NVw3g==","shasum":"5956237fc9f1b6819f6ef13c7e6fcf4ebbecc4e2","tarball":"https://registry.npmjs.org/@ayobami6/readme-generate/-/readme-generate-1.1.1.tgz","fileCount":6,"unpackedSize":5563,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAcy/n6vtg4m0j9Pr/AmiaX3mXoTL70z69u52YcbsGr3AiEAz/b57g6G1h1bJU3L9mMyuQnyjfbolJXDGxbIvR0Qyzo="}]},"_npmUser":{"name":"ayobami6","email":"ayobamidele006@gmail.com"},"directories":{},"maintainers":[{"name":"ayobami6","email":"ayobamidele006@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/readme-generate_1.1.1_1690640088143_0.4590540328293611"},"_hasShrinkwrap":false}},"time":{"created":"2023-07-29T11:31:06.890Z","1.0.0":"2023-07-29T11:31:07.078Z","modified":"2023-07-29T14:14:48.595Z","1.1.0":"2023-07-29T11:35:59.286Z","1.1.1":"2023-07-29T14:14:48.478Z"},"maintainers":[{"name":"ayobami6","email":"ayobamidele006@gmail.com"}],"description":"Generate a detialed readme with AI","keywords":["readme","generate","ai","openai","openai-api","cli","command-line"],"author":{"name":"Ayobami Alaran"},"license":"MIT","readme":"# Readme Generator\n\n![Languages](https://img.shields.io/github/languages/top/Ayobami6/readme-generate)\n![GitHub repo size](https://img.shields.io/github/repo-size/Ayobami6/readme-generate)\n![GitHub issues](https://img.shields.io/github/issues/Ayobami6/readme-generate)\n![GitHub closed issues](https://img.shields.io/github/issues-closed/Ayobami6/readme-generate)\n![GitHub pull requests](https://img.shields.io/github/issues-pr/Ayobami6/readme-generate)\n![GitHub](https://img.shields.io/github/license/Ayobami6/readme-generate)\n![GitHub Repo stars](https://img.shields.io/github/stars/Ayobami6/readme-generate?style=social)\n![GitHub forks](https://img.shields.io/github/forks/Ayobami6/readme-generate?style=social)\n![GitHub contributors](https://img.shields.io/github/contributors/Ayobami6/readme-generate)\n[![npm version](https://badge.fury.io/js/@ayobami6%2Freadme-generate.svg)](https://badge.fury.io/js/@ayobami6%2Freadme-generate)\n\nGenerate a detail and organized README.md file for your project using the command line with just simple prompt.\n\n## Usage\n\n- Install the package globally\n\n```sh\nnpm install -g @ayobami6/readme-generate\n```\n\n- Export your openai api key as an environment variable\n\n```sh\nexport OPENAI_API_KEY=your_api_key\n```\n\n- Run the command\n\n```sh\nreadme-generate\n```\n\n- Answer the prompt and your README.md file will be generated in the current directory.\n\nhttps://github.com/Ayobami6/readme-generate/assets/91608325/f559bcc6-0842-4b36-8750-4c13b8b804ea\n\n### Development Setup\n\n- Clone the repository\n\n```sh\ngit clone <url>\n```\n\n- cd into the project directory\n\n```sh\ncd readme-generate\n```\n\n- Install dependencies\n\n```sh\nnpm install or make install\n```\n\n- Run the script\n\n```sh\nnode index.js or make run\n```\n\n## Contributing\n\nContributions, issues and feature requests are welcome!\nfeel free to check [issues page]()\n\n## Show your support\n\nIf you find this project useful, please give it a ⭐️!\n\n<!-- LICENSE -->\n\n## 📝 License <a name=\"license\"></a>\n\nThis project is [MIT](./LICENSE) licensed.\n","readmeFilename":"README.md"}