{"id":22085513,"url":"https://github.com/tejasmr/genreadme","last_synced_at":"2026-05-05T12:34:00.316Z","repository":{"id":65162002,"uuid":"492225737","full_name":"tejasmr/genREADME","owner":"tejasmr","description":"Generate README.md with code snippets from the relative file paths","archived":false,"fork":false,"pushed_at":"2022-05-14T16:13:51.000Z","size":25,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-29T05:23:09.901Z","etag":null,"topics":["dockerfile","generator","github-actions","markdown","python","readme"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tejasmr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-05-14T13:35:12.000Z","updated_at":"2022-05-15T06:44:17.000Z","dependencies_parsed_at":"2023-01-04T12:39:03.835Z","dependency_job_id":null,"html_url":"https://github.com/tejasmr/genREADME","commit_stats":{"total_commits":43,"total_committers":2,"mean_commits":21.5,"dds":0.2093023255813954,"last_synced_commit":"17b79d41e51de6f741d852898bf82b84af8f0b14"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tejasmr%2FgenREADME","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tejasmr%2FgenREADME/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tejasmr%2FgenREADME/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tejasmr%2FgenREADME/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tejasmr","download_url":"https://codeload.github.com/tejasmr/genREADME/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245175476,"owners_count":20572787,"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":["dockerfile","generator","github-actions","markdown","python","readme"],"created_at":"2024-12-01T01:14:50.919Z","updated_at":"2026-05-05T12:34:00.246Z","avatar_url":"https://github.com/tejasmr.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# genREADME\n\n# Generated code snippets\n## Pokemon\n```c\n#include \u003cstdio.h\u003e\n\nint main() {\n    printf(\"pokemon\\n\");\n}\n```\n## Main\n```ts\nconsole.log(\"another\");\n```\n\n\n## Usage\n\nTo Generate a README.md with code snippets. In your MAIN.md or any other file, use\n`gen =\u003e [alt-name](link)`\nfor creating a code snippet.\n1. alt-name will be the title if with_title = true and it is not empty\n2. other wise if with_title = true, the the filename with first letter capitalized will be the title\n3. link refers to the relative path to the file\n\n### Example workflow\n\n```yaml\nname: My Workflow\non: [push, pull_request]\njobs:\n  build:\n    runs-on: ubuntu-latest\n    steps:\n    - uses: actions/checkout@v3\n    - name: Generate README.md\n      uses: tezz-io/genREADME@main\n      with:\n        file: \"MAIN.md\"\n        with_title: \"true\"\n        n_hashes: \"2\"\n    - name: Setup Username and email\n    run: |\n        git config user.name github-actions\n        git config user.email github-actions@github.com\n    - name: Push generated README.md  \n    run: |\n        git add .\n        git commit -m \"Generated README.md\"\n        git push\n```\n\n### Inputs\n\n| Input                                             | Description                                        |\n|------------------------------------------------------|-----------------------------------------------|\n| `file`  | Path to MAIN.md or other .md file    |\n| `with_title`  | Whether the title of the snippet should be present    |\n| `n_hashes`  | The number of hashes before the title    |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftejasmr%2Fgenreadme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftejasmr%2Fgenreadme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftejasmr%2Fgenreadme/lists"}