{"id":16212850,"url":"https://github.com/mdyeates/readme-generator","last_synced_at":"2026-04-26T12:31:36.850Z","repository":{"id":65403925,"uuid":"591721608","full_name":"mdyeates/readme-generator","owner":"mdyeates","description":"Simplify the documentation process for your projects by effortlessly creating high-quality and informative README.md files","archived":false,"fork":false,"pushed_at":"2023-03-11T02:19:29.000Z","size":24896,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-07T21:52:06.858Z","etag":null,"topics":["inquirer","javascript","nodejs"],"latest_commit_sha":null,"homepage":"","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/mdyeates.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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}},"created_at":"2023-01-21T16:55:14.000Z","updated_at":"2023-08-31T12:48:14.000Z","dependencies_parsed_at":"2024-11-03T17:41:12.336Z","dependency_job_id":"f3f55046-46de-490a-b030-512d9a2d717c","html_url":"https://github.com/mdyeates/readme-generator","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mdyeates/readme-generator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdyeates%2Freadme-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdyeates%2Freadme-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdyeates%2Freadme-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdyeates%2Freadme-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mdyeates","download_url":"https://codeload.github.com/mdyeates/readme-generator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mdyeates%2Freadme-generator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32297893,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-26T09:34:17.070Z","status":"ssl_error","status_checked_at":"2026-04-26T09:34:00.993Z","response_time":129,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["inquirer","javascript","nodejs"],"created_at":"2024-10-10T10:53:46.715Z","updated_at":"2026-04-26T12:31:36.834Z","avatar_url":"https://github.com/mdyeates.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\n  \u003c!-- PROJECT SHIELDS --\u003e\n\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n[![LinkedIn][linkedin-shield]][linkedin-url]\n\n  \u003c!-- PROJECT LOGO --\u003e\n\n  \u003cbr /\u003e\n  \u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://github.com/mdyeates/readme-generator\"\u003e\n      \u003cimg src=\"assets/logo.png\" alt=\"Logo\" width=\"200\" height=\"200\"\u003e\n    \u003c/a\u003e\n    \u003ch3 align=\"center\"\u003eProfessional README Generator\u003c/h3\u003e\n    \u003cp align=\"center\"\u003e\n    \u003cbr/\u003e\n    Simplify the documentation process for your projects by effortlessly creating high-quality and informative README.md files\n    \u003cbr/\u003e\n      \u003cbr/\u003e\n      Professional README Generator is proudly built by: Michael Yeates\n      \u003cbr/\u003e\n      \u003cbr/\u003e\n      \u003ca href=\"https://github.com/mdyeates/readme-generator\"\u003e\u003cstrong\u003eExplore the docs »\u003c/strong\u003e\u003c/a\u003e\n      \u003cbr/\u003e\n      \u003cbr/\u003e\n      \u003ca href=\"https://drive.google.com/file/d/1An-iMejFYy7drNO4IRWt8gJLWnfxd_21/view\"\u003eView Walkthrough Video\u003c/a\u003e\n      ·\n      \u003ca href=\"https://github.com/mdyeates/readme-generator/issues\"\u003eReport Bug\u003c/a\u003e\n      ·\n      \u003ca href=\"https://github.com/mdyeates/readme-generator/issues\"\u003eRequest Feature\u003c/a\u003e\n    \u003c/p\u003e\n  \u003c/div\u003e\n  \n  \u003c!-- TABLE OF CONTENTS --\u003e\n\n  \u003cdetails\u003e\n    \u003csummary\u003eTable of Contents\u003c/summary\u003e\n    \u003col\u003e\n      \u003cli\u003e\n        \u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\n        \u003cul\u003e\n          \u003cli\u003e\u003ca href=\"#screenshot\"\u003eScreenshot\u003c/a\u003e\u003c/li\u003e\n          \u003cli\u003e\u003ca href=\"#built-with\"\u003eBuilt With\u003c/a\u003e\u003c/li\u003e\n          \u003cli\u003e\u003ca href=\"#description\"\u003eDescription\u003c/a\u003e\u003c/li\u003e\n        \u003c/ul\u003e\n      \u003c/li\u003e\n      \u003cli\u003e\n          \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n        \u003cul\u003e\n          \u003cli\u003e\u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\u003c/li\u003e\n          \u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n        \u003c/ul\u003e\n      \u003c/li\u003e\n      \u003cli\u003e\n          \u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\n        \u003cul\u003e\n          \u003cli\u003e\u003ca href=\"#functionality\"\u003eFunctionality\u003c/a\u003e\u003c/li\u003e\n    \u003c!-- \u003cli\u003e\u003ca href=\"#mobile-responsive\"\u003eMobile Responsive\u003c/a\u003e\u003c/li\u003e --\u003e\n        \u003c/ul\u003e\n      \u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"#tests\"\u003eTests\u003c/a\u003e\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"#questions\"\u003eQuestions\u003c/a\u003e\u003c/li\u003e\n      \u003cli\u003e\u003ca href=\"#acknowledgments\"\u003eAcknowledgments\u003c/a\u003e\u003c/li\u003e\n    \u003c/ol\u003e\n  \u003c/details\u003e\n  \n  \u003c!-- ABOUT THE PROJECT --\u003e\n  \n  ## About The Project\n  \n  ### Screenshot\n  \n  [![Professional README Generator Screen Shot][product-screenshot]](https://drive.google.com/file/d/1An-iMejFYy7drNO4IRWt8gJLWnfxd_21/view)\n  \n  \u003cp align=\"right\"\u003e\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e\u003c/p\u003e\n  \n  ### Built With\n  \n  - ![JavaScript](https://img.shields.io/badge/JavaScript-20232A?style=for-the-badge\u0026logo=JavaScript\u0026logoColor=FCDD32)\n\n- ![Node.js](https://img.shields.io/badge/Node.js-376e05?style=for-the-badge\u0026logo=Node.js\u0026logoColor=white)\n\n  \u003cp align=\"right\"\u003e\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e\u003c/p\u003e\n\n  ### Description\n\n  It has never been easier to document your repository projects than with this command-line application built using Node.js. Simply provide information about your project and let it do the rest. The generated README file includes sections for the project title, description, a table of contents, installation, usage, license, contributing, tests and questions. Additionally, the user can also select a license from a list of options, which will add a badge near the top of the README file and include a reference in the license section. The user's GitHub username and email address are also added to the questions section. For easy navigation, the table of contents includes links that take users to the relevant sections.\n\n  \u003cp align=\"right\"\u003e\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e\u003c/p\u003e\n\n\u003c!-- GETTING STARTED --\u003e\n\n## Getting Started\n\nTo get a local copy up and running follow these simple example steps.\n\n### Prerequisites\n\n- npm\n  ```sh\n  npm install npm@latest -g\n  ```\n\n### Installation\n\n1. Clone the repo\n   ```sh\n   git clone https://github.com/mdyeates/readme-generator.git\n   ```\n2. Install NPM packages\n   ```sh\n   npm install\n   ```\n\n  \u003cp align=\"right\"\u003e\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e\u003c/p\u003e\n  \n  \u003c!-- USAGE EXAMPLES --\u003e\n  \n  ## Usage\n  \n  ### Functionality\n  \n  - The following animation demonstrates the applications functionality. Click the gif to view the shared video on Google Drive.\n  \n    [![Functionality Gif][functionality-gif]](https://drive.google.com/file/d/1An-iMejFYy7drNO4IRWt8gJLWnfxd_21/view)\n\n  \u003cp align=\"right\"\u003e\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e\u003c/p\u003e\n  \n  \u003c!--### Mobile Responsive\n  \n  - As demonstrated in the screenshot below, this application is designed to be responsive and adjust seamlessly to fit various screen sizes\n  \n    [![Responsiveness Screenshot][responsive-screenshot]](https://mdyeates.github.io/readme-generator/)\n  \n  \u003cp align=\"right\"\u003e\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e\u003c/p\u003e --\u003e\n\n  \u003c!-- LICENSE --\u003e\n\n## License\n\nDistributed under the MIT License. See `LICENSE.md` for more information.\n\n  \u003cp align=\"right\"\u003e\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e\u003c/p\u003e\n  \n  \u003c!-- CONTRIBUTING --\u003e\n  \n  ## Contributing\n  \n  Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n  \n  If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag \"enhancement\".\n  Don't forget to give the project a star! Thanks again!\n  \n  1. Fork the Project\n  2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n  3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n  4. Push to the Branch (`git push origin feature/AmazingFeature`)\n  5. Open a Pull Request\n  \n  \u003cp align=\"right\"\u003e\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e\u003c/p\u003e\n\n  \u003c!-- TESTS --\u003e\n\n## Tests\n\nN/A\n\n  \u003cp align=\"right\"\u003e\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e\u003c/p\u003e\n  \n  \u003c!-- QUESTIONS --\u003e\n  \n  ## Questions\n\nIf you have any inquiries, don't hesitate to reach out to me via socials or by sending an email to \u003ca href=\"mailto:michael-yeates@outlook.com\"\u003emichael-yeates@outlook.com\u003c/a\u003e\n\n\u003ca href=\"https://www.linkedin.com/in/mdyeates/\"\u003eLinkedIn\u003c/a\u003e | \u003ca href=\"https://github.com/mdyeates/\"\u003eGitHub\u003c/a\u003e\n\nProject Link: [https://github.com/mdyeates/readme-generator](https://github.com/mdyeates/readme-generator)\n\n  \u003cp align=\"right\"\u003e\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e\u003c/p\u003e\n  \n  \u003c!-- ACKNOWLEDGMENTS --\u003e\n  \n  ## Acknowledgments\n\n- [https://www.npmjs.com/package/inquirer](https://www.npmjs.com/package/inquirer)\n\n  \u003cp align=\"right\"\u003e\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e\u003c/p\u003e\n\n  \u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\n[contributors-shield]: https://img.shields.io/github/contributors/mdyeates/readme-generator.svg?style=for-the-badge\n[contributors-url]: https://github.com/mdyeates/readme-generator/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/mdyeates/readme-generator.svg?style=for-the-badge\n[forks-url]: https://github.com/mdyeates/readme-generator/network/members\n[stars-shield]: https://img.shields.io/github/stars/mdyeates/readme-generator.svg?style=for-the-badge\n[stars-url]: https://github.com/mdyeates/readme-generator/stargazers\n[issues-shield]: https://img.shields.io/github/issues/mdyeates/readme-generator.svg?style=for-the-badge\n[issues-url]: https://github.com/mdyeates/readme-generator/issues\n[license-shield]: https://img.shields.io/github/license/mdyeates/readme-generator.svg?style=for-the-badge\n[license-url]: https://github.com/mdyeates/readme-generator/blob/main/LICENSE\n[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge\u0026logo=linkedin\u0026colorB=555\n[linkedin-url]: https://linkedin.com/in/mdyeates\n\n  \u003c!-- UPDATE PLACEHOLDER IMAGES HERE --\u003e\n\n[product-screenshot]: assets/screenshot.png\n[functionality-gif]: assets/readme-gen.gif\n[responsive-screenshot]: https://placehold.co/600x400?text=Placeholder\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmdyeates%2Freadme-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmdyeates%2Freadme-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmdyeates%2Freadme-generator/lists"}