{"id":23685991,"url":"https://github.com/asmaelabid/project-readme-gen","last_synced_at":"2025-06-13T05:04:05.539Z","repository":{"id":270038309,"uuid":"909130959","full_name":"asmaelabid/project-readme-gen","owner":"asmaelabid","description":"This open-source npm package leverages AI to analyze your project structure and automatically generate a professional, detailed, and SEO-friendly README file. It simplifies documentation by creating sections for installation, usage, features, and more—all tailored to your project. Perfect for developers looking to enhance project visibility.","archived":false,"fork":false,"pushed_at":"2025-01-12T21:36:54.000Z","size":61,"stargazers_count":10,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-11T05:35:18.121Z","etag":null,"topics":["ai-generated-readme","automation","developer-tools","npm-package","open-source","openai","project-documentation","readme-builder","readme-generator"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/project-readme-gen","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/asmaelabid.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-12-27T20:11:20.000Z","updated_at":"2025-03-22T11:29:52.000Z","dependencies_parsed_at":"2024-12-27T23:36:48.593Z","dependency_job_id":"b231b651-5a2a-4db1-a0ad-34df1c4bee74","html_url":"https://github.com/asmaelabid/project-readme-gen","commit_stats":null,"previous_names":["asmaelabid/project-readme-gen"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/asmaelabid/project-readme-gen","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asmaelabid%2Fproject-readme-gen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asmaelabid%2Fproject-readme-gen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asmaelabid%2Fproject-readme-gen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asmaelabid%2Fproject-readme-gen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/asmaelabid","download_url":"https://codeload.github.com/asmaelabid/project-readme-gen/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asmaelabid%2Fproject-readme-gen/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259584751,"owners_count":22880194,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai-generated-readme","automation","developer-tools","npm-package","open-source","openai","project-documentation","readme-builder","readme-generator"],"created_at":"2024-12-29T21:16:49.454Z","updated_at":"2025-06-13T05:04:05.422Z","avatar_url":"https://github.com/asmaelabid.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Project README Generator 🚀\n\n[![NPM Version](https://img.shields.io/npm/v/project-readme-gen.svg)](https://www.npmjs.com/package/project-readme-gen)\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)\n\n## 📖 Overview\n\nAI-powered README generator that automatically creates professional documentation for your projects. Transform your codebase into well-structured, SEO-friendly markdown documentation with just one command.\n\n## ✨ Key Features\n\n- 🤖 AI-powered content generation\n- 📝 Automatic project analysis\n- 🎯 SEO-optimized documentation\n- 🔧 CLI support for easy integration\n- 📊 Smart project structure detection\n- 🚀 Instant markdown formatting\n- 💡 Code example inclusion\n\n## 🛠️ Installation\n\n```bash\nnpm install -g project-readme-gen\n```\n## 🚀 Usage\nGenerate a README for your project:\n```bash\nreadme-gen \u003cproject-path\u003e\n```\n## 🤝 Contributing\nContributions welcome! Please read our contributing guidelines.\n\n## 🌟 Star us on GitHub\nIf you find this tool helpful, please consider giving it a star!\n\n\nBuilt with ❤️ by [aelabid]\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasmaelabid%2Fproject-readme-gen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fasmaelabid%2Fproject-readme-gen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasmaelabid%2Fproject-readme-gen/lists"}