{"id":13465081,"url":"https://github.com/ddbeck/readme-checklist","last_synced_at":"2026-01-28T14:02:42.780Z","repository":{"id":145921947,"uuid":"58968465","full_name":"ddbeck/readme-checklist","owner":"ddbeck","description":"A checklist for writing READMEs","archived":false,"fork":false,"pushed_at":"2023-03-28T11:29:57.000Z","size":95,"stargazers_count":638,"open_issues_count":1,"forks_count":76,"subscribers_count":20,"default_branch":"main","last_synced_at":"2025-03-21T04:25:26.581Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ddbeck.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}},"created_at":"2016-05-16T21:17:40.000Z","updated_at":"2025-03-09T21:18:42.000Z","dependencies_parsed_at":null,"dependency_job_id":"d0cb8b42-94d2-4731-bb3b-8bdd2e8cc95b","html_url":"https://github.com/ddbeck/readme-checklist","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ddbeck/readme-checklist","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ddbeck%2Freadme-checklist","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ddbeck%2Freadme-checklist/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ddbeck%2Freadme-checklist/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ddbeck%2Freadme-checklist/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ddbeck","download_url":"https://codeload.github.com/ddbeck/readme-checklist/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ddbeck%2Freadme-checklist/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28846058,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-28T13:02:32.985Z","status":"ssl_error","status_checked_at":"2026-01-28T13:02:04.945Z","response_time":57,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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":[],"created_at":"2024-07-31T14:00:57.989Z","updated_at":"2026-01-28T14:02:42.774Z","avatar_url":"https://github.com/ddbeck.png","language":null,"funding_links":[],"categories":["Others","Templates","License","🔧 Utilities \u0026 Miscellaneous"],"sub_categories":["JetBrains","Journal and Conference Papers"],"readme":"# [README checklist](https://github.com/ddbeck/readme-checklist)\n\nby [Daniel D. Beck](https://ddbeck.com/)\n\n[checklist.md](checklist.md) is a checklist to help you write a README file\nthat helps readers feel confident about your project. If you write a README by\nfollowing the checklist, then your readers may more easily identify, evaluate,\nuse, and engage with your project. Unlike README templates, this checklist\nhelps you write the most important things first, not only what appears first in\nthe file. You can use the checklist for both closed- and open-source projects.\n\nFor more about how this checklist was created and its use, see the talk I gave\nat [Write the Docs NA 2016](https://www.writethedocs.org/videos/na/2016/write-the-readable-readme-daniel-beck/),\n*[Write the Readable README](https://ddbeck.com/wtdna2016/)*.\n\nYou are free to copy, modify, and distribute this checklist, even for\ncommercial purposes, without asking for permission. Please adapt this\nchecklist for your own use. See\n*[Public domain dedication](#public-domain-dedication)* for details.\n\n\n## How to use the checklist\n\nView the latest version of the checklist at:\n\nhttps://github.com/ddbeck/readme-checklist/blob/main/checklist.md\n\nThis checklist is a *READ-DO* checklist. If you're starting a new README file,\nfollow the checklist like a recipe, reading each step and completing it, in\norder. Alternatively, if you've already started a README file, you may find it\nuseful to treat the checklist as a *DO-CONFIRM* checklist, confirming that your\nREADME matches the elements of the checklist after you've finished writing.\n\nWith a few exceptions, the checklist is agnostic about what order things appear\nin your README or even what kind of project you're documenting. Your README may\ncover other topics not covered by this checklist; the checklist covers only\nthose topics I found to be essential for README files.\n\n\n## Contributing to this checklist\n\nIf you have suggestions for improving the checklist, please [open an issue or\npull request on GitHub](https://github.com/ddbeck/readme-checklist/).\n\n\n## Public domain dedication\n\n[This work is dedicated to the public domain (CC0\n1.0)](http://creativecommons.org/publicdomain/zero/1.0/). To the extent\npossible under law, Daniel D. Beck has waived all copyright and related or\nneighboring rights to the README checklist. See the [LICENSE](LICENSE) file for\nall the legalese.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fddbeck%2Freadme-checklist","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fddbeck%2Freadme-checklist","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fddbeck%2Freadme-checklist/lists"}