{"_id":"@debjit_kundu/auto-readme","_rev":"2-f118b493b34de29204628310b228df54","name":"@debjit_kundu/auto-readme","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@debjit_kundu/auto-readme","version":"1.0.0","keywords":["readme","generator","documentation","markdown","ai","DeK"],"author":{"name":"debjit kundu"},"license":"MIT","_id":"@debjit_kundu/auto-readme@1.0.0","maintainers":[{"name":"debjit_kundu","email":"debjitkundu11@gmail.com"}],"homepage":"https://github.com/debjit-1004/auto-readme-npm-package#readme","bugs":{"url":"https://github.com/debjit-1004/auto-readme-npm-package/issues"},"bin":{"autoreadme":"src/cli.js"},"dist":{"shasum":"a8be141ae4b9289353955192ce06aee285c14a2d","tarball":"https://registry.npmjs.org/@debjit_kundu/auto-readme/-/auto-readme-1.0.0.tgz","fileCount":12,"integrity":"sha512-Ul/6ArC1udiv3ET89ZzA+GTvKjiogjIjZDCBD5RNnLFJXIq81mITxedoB1ViS38U85vc//PAC7Ia6bKbZ+6L/g==","signatures":[{"sig":"MEYCIQDbib0IFjnr96hKoQn+pLz6l2tAowzh/AjCsmMU8OzxlwIhAMFqJpQDIoWTrc7Ysp/CCiivIuPEhnIoFQvVVdeOp1hv","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":14556},"main":"src/cli.js","type":"module","engines":{"node":">=16.0.0"},"gitHead":"a18aaaa5a3cf1585342f38e146fea5c931130b48","scripts":{"gen":"autoreadme --generate","init":"autoreadme --init","test":"echo \"Error: no test specified\" && exit 1","start":"autoreadme --watch"},"_npmUser":{"name":"debjit_kundu","email":"debjitkundu11@gmail.com"},"repository":{"url":"git+https://github.com/debjit-1004/auto-readme-npm-package.git","type":"git"},"_npmVersion":"10.9.2","description":"Automatically generate beautiful README files for your projects using AI","directories":{},"_nodeVersion":"22.14.0","dependencies":{"yargs":"^17.7.2","dotenv":"^16.3.1","globby":"^14.0.0","limiter":"^2.1.0","chokidar":"^3.6.0","enquirer":"^2.4.1","groq-sdk":"^0.19.0","lodash.debounce":"^4.0.8"},"_hasShrinkwrap":false,"devDependencies":{},"_npmOperationalInternal":{"tmp":"tmp/auto-readme_1.0.0_1744287816153_0.11458017590035108","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@debjit_kundu/auto-readme","version":"1.0.1","description":"Automatically generate beautiful README files for your projects using AI","type":"module","main":"src/cli.js","bin":{"autoreadme":"src/cli.js"},"scripts":{"start":"autoreadme --watch","gen":"autoreadme --generate","init":"autoreadme --init","test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/debjit-1004/auto-readme-npm-package.git"},"keywords":["readme","generator","documentation","markdown","ai","DeK"],"author":{"name":"debjit kundu"},"license":"MIT","bugs":{"url":"https://github.com/debjit-1004/auto-readme-npm-package/issues"},"homepage":"https://github.com/debjit-1004/auto-readme-npm-package#readme","dependencies":{"chokidar":"^3.6.0","dotenv":"^16.3.1","globby":"^14.0.0","groq-sdk":"^0.19.0","limiter":"^2.1.0","lodash.debounce":"^4.0.8","yargs":"^17.7.2","enquirer":"^2.4.1"},"engines":{"node":">=16.0.0"},"devDependencies":{},"_id":"@debjit_kundu/auto-readme@1.0.1","gitHead":"d78c7f89c1715a1c935ce0b1ff4e6b2257b6aebd","_nodeVersion":"22.14.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-k+oZc9xqL293EiOUn9OCS3m+yLFmxtu+iWJ3Cfk8Z0Wv0c1ZIAg0x+1+Zp3ViLCcB0KI9A78zXem+IrVA5/s6Q==","shasum":"cb6cc17bb0484aeeed8b05c7566e13c8bd827a84","tarball":"https://registry.npmjs.org/@debjit_kundu/auto-readme/-/auto-readme-1.0.1.tgz","fileCount":12,"unpackedSize":14556,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQC5G+YPp/i0E9FExaEwgP1qJh8mPSMdMkpsJ0/POGblgQIhAP30jKwjHb2xf5VqQ54vHI/D+VjMivyXC6YthSV60d/k"}]},"_npmUser":{"name":"debjit_kundu","email":"debjitkundu11@gmail.com"},"directories":{},"maintainers":[{"name":"debjit_kundu","email":"debjitkundu11@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/auto-readme_1.0.1_1744288157439_0.4212027303114463"},"_hasShrinkwrap":false}},"time":{"created":"2025-04-10T12:23:36.096Z","modified":"2025-04-10T12:29:17.823Z","1.0.0":"2025-04-10T12:23:36.334Z","1.0.1":"2025-04-10T12:29:17.639Z"},"bugs":{"url":"https://github.com/debjit-1004/auto-readme-npm-package/issues"},"author":{"name":"debjit kundu"},"license":"MIT","homepage":"https://github.com/debjit-1004/auto-readme-npm-package#readme","keywords":["readme","generator","documentation","markdown","ai","DeK"],"repository":{"type":"git","url":"git+https://github.com/debjit-1004/auto-readme-npm-package.git"},"description":"Automatically generate beautiful README files for your projects using AI","maintainers":[{"name":"debjit_kundu","email":"debjitkundu11@gmail.com"}],"readme":"# auto-readme\r\n\r\n<!-- AUTO-DESCRIPTION -->\r\nAuto-generate README files for your projects using AI. This tool watches your project files for changes and automatically updates your README with relevant information.\r\n<!-- /AUTO-DESCRIPTION -->\r\n\r\n## Table of Contents\r\n- [Installation](#installation)\r\n- [Usage](#usage)\r\n- [Features](#features)\r\n- [Contributing](#contributing)\r\n- [License](#license)\r\n\r\n## Installation\r\n<!-- AUTO-INSTALLATION -->\r\n```bash\r\n# Install globally\r\nnpm install -g auto-readme\r\n\r\n# Or locally in your project\r\nnpm install --save-dev auto-readme\r\n```\r\n<!-- /AUTO-INSTALLATION -->\r\n\r\n## Usage\r\n<!-- AUTO-USAGE -->\r\n```bash\r\n# Initialize configuration\r\nnpm run init\r\n\r\n# Generate README once\r\nnpm run gen\r\n\r\n# Watch for changes\r\nnpm start\r\n```\r\n\r\nIn your project, you can create a custom readme template in `templates/readme-template.md`. The template uses special tag pairs to define sections that can be automatically updated:\r\n\r\n```markdown\r\n<!-- AUTO-SECTION_NAME -->\r\nContent will be replaced by AI\r\n<!-- /AUTO-SECTION_NAME -->\r\n```\r\n\r\nSections not defined in `autoSections` in your config will preserve manual edits.\r\n\r\nExample configuration (`readme-gen.config.json`):\r\n```json\r\n{\r\n  \"watchPaths\": [\"src/**/*\", \"package.json\"],\r\n  \"ignorePatterns\": [\"**/node_modules/**\", \"**/dist/**\"],\r\n  \"model\": \"mixtral-8x7b-32768\",\r\n  \"templatePath\": \"./templates/readme-template.md\",\r\n  \"autoSections\": [\r\n    \"description\",\r\n    \"installation\",\r\n    \"usage\",\r\n    \"contributing\"\r\n  ],\r\n  \"debounce\": 2000\r\n}\r\n```\r\n<!-- /AUTO-USAGE -->\r\n\r\n## Features\r\n<!-- AUTO-FEATURES -->\r\n- AI-powered README generation using Groq API\r\n- Watch mode for automatic updates\r\n- Custom templates with manual section preservation\r\n- Rate limiting to prevent API overuse\r\n- Support for multiple AI models\r\n- Project context analysis for relevant documentation\r\n<!-- /AUTO-FEATURES -->\r\n\r\n## Contributing\r\n<!-- AUTO-CONTRIBUTING -->\r\nContributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.\r\n<!-- /AUTO-CONTRIBUTING -->\r\n\r\n## License\r\n<!-- AUTO-LICENSE -->\r\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\r\n<!-- /AUTO-LICENSE -->","readmeFilename":"README.md"}