{"id":13625998,"url":"https://github.com/dguo/make-a-readme","last_synced_at":"2025-06-17T18:09:37.744Z","repository":{"id":23943374,"uuid":"100219377","full_name":"dguo/make-a-readme","owner":"dguo","description":":page_facing_up: Because nobody can read your mind (yet)","archived":false,"fork":false,"pushed_at":"2024-07-13T12:53:10.000Z","size":2968,"stargazers_count":711,"open_issues_count":10,"forks_count":106,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-04-16T13:33:48.244Z","etag":null,"topics":["guidelines","readme","readme-template"],"latest_commit_sha":null,"homepage":"https://makeareadme.com","language":"TypeScript","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/dguo.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},"funding":{"github":"dguo","ko_fi":"dannyguo","liberapay":"dannyguo","buy_me_a_coffee":"dannyguo","custom":["https://www.paypal.me/DannyGuo"]}},"created_at":"2017-08-14T02:17:23.000Z","updated_at":"2025-04-14T22:51:12.000Z","dependencies_parsed_at":"2024-01-03T03:07:23.394Z","dependency_job_id":"082f1c8f-86cf-46ba-aa01-1c2fa436b9b3","html_url":"https://github.com/dguo/make-a-readme","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/dguo/make-a-readme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dguo%2Fmake-a-readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dguo%2Fmake-a-readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dguo%2Fmake-a-readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dguo%2Fmake-a-readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dguo","download_url":"https://codeload.github.com/dguo/make-a-readme/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dguo%2Fmake-a-readme/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260415157,"owners_count":23005510,"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":["guidelines","readme","readme-template"],"created_at":"2024-08-01T21:02:07.448Z","updated_at":"2025-06-17T18:09:32.314Z","avatar_url":"https://github.com/dguo.png","language":"TypeScript","funding_links":["https://github.com/sponsors/dguo","https://ko-fi.com/dannyguo","https://liberapay.com/dannyguo","https://buymeacoffee.com/dannyguo","https://www.paypal.me/DannyGuo"],"categories":["TypeScript"],"sub_categories":[],"readme":"# Make a README\n\n[![Netlify Status](https://api.netlify.com/api/v1/badges/68992d1c-36d4-4a84-b177-00c1f64fbcb4/deploy-status)](https://app.netlify.com/sites/make-a-readme/deploys)\n[![CI status](https://github.com/dguo/make-a-readme/workflows/CI/badge.svg)](https://github.com/dguo/make-a-readme/actions?query=branch%3Amain)\n\n[Make a README](https://makeareadme.com) explains what a README is, what the\nbenefits are, and what makes for a good README. It also provides an editable\ntemplate, with live Markdown rendering.\n\nI hope people who are new to programming will find it useful, but even for\nmore experienced programmers, I think it's worth evaluating once\nin a while if we are doing a good job when it comes to the\n[small details](https://chris.beams.io/posts/git-commit/) that\ncan matter more than we might think.\n\nMake a README is inspired by [Keep a Changelog](http://keepachangelog.com/).\n\n## Related Resources\n\n- [Art of README](https://github.com/noffle/art-of-readme)\n- [Awesome README](https://github.com/matiassingers/awesome-readme)\n- [Standard Readme](https://github.com/RichardLitt/standard-readme)\n\n## Roadmap\n\n- Translate the website\n- Create an interactive README generator ([#15](https://github.com/dguo/make-a-readme/issues/15))\n- Link to great examples ([#14](https://github.com/dguo/make-a-readme/issues/14))\n- check and improve accessibility\n\n## Contributing\n\nPlease feel free to submit an issue or pull request. To develop, you'll need\nNode.js. Run `yarn install \u0026\u0026 yarn dev`.\n\n## License\n\n[MIT](https://github.com/dguo/make-a-readme/blob/main/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdguo%2Fmake-a-readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdguo%2Fmake-a-readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdguo%2Fmake-a-readme/lists"}