{"id":26514709,"url":"https://github.com/coderrob/update-readme","last_synced_at":"2026-05-05T14:31:58.199Z","repository":{"id":274992585,"uuid":"924493235","full_name":"Coderrob/update-readme","owner":"Coderrob","description":"A GitHub Action that keeps your repository’s README.md fresh and clean! Automatically generates or updates your README with technical documentation and usage examples, ensuring your project stays well-documented with zero hassle.","archived":false,"fork":false,"pushed_at":"2025-09-21T05:51:23.000Z","size":1518,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-21T07:24:52.388Z","etag":null,"topics":["documentation-tool","github-actions","readme","self-documenting"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Coderrob.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":["coderrob"],"buy_me_a_coffee":"coderrob"}},"created_at":"2025-01-30T05:25:32.000Z","updated_at":"2025-09-21T05:51:26.000Z","dependencies_parsed_at":"2025-10-01T03:21:55.189Z","dependency_job_id":null,"html_url":"https://github.com/Coderrob/update-readme","commit_stats":null,"previous_names":["coderrob/update-action-readme"],"tags_count":4,"template":false,"template_full_name":"actions/typescript-action","purl":"pkg:github/Coderrob/update-readme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Coderrob%2Fupdate-readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Coderrob%2Fupdate-readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Coderrob%2Fupdate-readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Coderrob%2Fupdate-readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Coderrob","download_url":"https://codeload.github.com/Coderrob/update-readme/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Coderrob%2Fupdate-readme/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32653493,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-05T11:29:49.557Z","status":"ssl_error","status_checked_at":"2026-05-05T11:29:48.587Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5: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":["documentation-tool","github-actions","readme","self-documenting"],"created_at":"2025-03-21T05:29:08.297Z","updated_at":"2026-05-05T14:31:58.182Z","avatar_url":"https://github.com/Coderrob.png","language":"TypeScript","funding_links":["https://github.com/sponsors/coderrob","https://buymeacoffee.com/coderrob"],"categories":[],"sub_categories":[],"readme":"# Update README.md with Action Metadata\n\nUpdates a README.md file with metadata from an action's YAML configuration file.\nThis includes information such as the action name, description, inputs, outputs,\nand other relevant details.\n\n## Branding\n\n| Attribute | Value |\n| --------- | ----- |\n| Color     | green |\n| Icon      | book  |\n\n## Inputs\n\n| Name              | Description                                                                                                                                     | Default                         | Required |\n| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | -------- |\n| action-file-path  | The path to the YAML configuration file for the action. This is relative to the repository root. If not specified, it defaults to 'action.yml'. | ./action.yml                    | ✅ Yes   |\n| action-repository | The repository where the action is located. This is used to generate links and references within the README.md file.                            | ${{ github.action_repository }} | ❌ No    |\n| readme-file-path  | The path to the README.md file that should be updated. This is relative to the repository root. If not specified, it defaults to 'README.md'.   | ./README.md                     | ✅ Yes   |\n\n## Outputs\n\nThis action does not define any outputs.\n\n## Runs\n\n**Execution Type:** node20\n\n## Example Usage\n\n```yaml\njobs:\n  example:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout Source\n        id: checkout-source\n        uses: actions/checkout@v2\n\n      - name: Update README.md with Action Metadata\n        uses: Coderrob/update-action-readme@v1\n        with:\n          action-file-path: \u003cvalue\u003e\n          action-repository: \u003cvalue\u003e\n          readme-file-path: \u003cvalue\u003e\n```\n\n## Acknowledgments\n\nThis project leverages Markdown generation techniques from\n[coderrob.com](https://coderrob.com), developed by **Robert Lindley**.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoderrob%2Fupdate-readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoderrob%2Fupdate-readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoderrob%2Fupdate-readme/lists"}