{"id":13477617,"url":"https://github.com/muesli/readme-scribe","last_synced_at":"2025-04-13T04:16:45.917Z","repository":{"id":41088266,"uuid":"281278772","full_name":"muesli/readme-scribe","owner":"muesli","description":"A GitHub Action that automatically generates \u0026 updates markdown content (like your README.md)","archived":false,"fork":false,"pushed_at":"2021-06-22T14:58:31.000Z","size":546,"stargazers_count":536,"open_issues_count":3,"forks_count":32,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-05T18:04:32.621Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":null,"language":null,"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/muesli.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":null,"security":null,"support":null},"funding":{"github":"muesli"}},"created_at":"2020-07-21T02:50:15.000Z","updated_at":"2025-03-29T13:25:14.000Z","dependencies_parsed_at":"2023-01-11T17:22:04.110Z","dependency_job_id":null,"html_url":"https://github.com/muesli/readme-scribe","commit_stats":{"total_commits":15,"total_committers":2,"mean_commits":7.5,"dds":0.06666666666666665,"last_synced_commit":"d2f6ab32d6b9f5b59941fe782d6c7e6499a37fe4"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muesli%2Freadme-scribe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muesli%2Freadme-scribe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muesli%2Freadme-scribe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/muesli%2Freadme-scribe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/muesli","download_url":"https://codeload.github.com/muesli/readme-scribe/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248647257,"owners_count":21139081,"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":["hacktoberfest"],"created_at":"2024-07-31T16:01:45.184Z","updated_at":"2025-04-13T04:16:45.779Z","avatar_url":"https://github.com/muesli.png","language":null,"funding_links":["https://github.com/sponsors/muesli"],"categories":["Others","hacktoberfest"],"sub_categories":[],"readme":"# readme-scribe\n\nA GitHub Action that automatically generates \u0026 updates markdown content (like your README.md)\n\n## Instructions\n\n1. Create a [markscribe](https://github.com/muesli/markscribe) template and\nplace it anywhere in a repository that you automatically want to update. In this\nguide we will use `templates/README.md.tpl`.\n\nYou can find an example template that I use to automatically update my GitHub\nprofile here: https://github.com/muesli/markscribe/blob/master/templates/github-profile.tpl\n\n2. In order to access some of GitHub's API, you need to provide a valid GitHub\ntoken as a secret called `PERSONAL_GITHUB_TOKEN`. You can create a new token by\ngoing to your profile settings:\n\n`Developer settings` \u003e `Personal access tokens` \u003e `Generate new token`\n\nDepending on your template you will need access to different API scopes. If you\nwant to support the full set of features, tick the checkboxes next to these\nscopes: `read:user`, `repo:status`, `public_repo`, `read:org`. Check out the\n[markscribe](https://github.com/muesli/markscribe) documentation for a detailed\nlist of required scopes for each individual template function.\n\nNow create a new secret in your repository's `Settings` and enter that token.\n\n3. Create a new GitHub workflow in your repository: `.github/workflows/readme-scribe.yml`\n\n```yml\nname: Update README\n\non:\n  push:\n  schedule:\n    - cron: \"0 */1 * * *\"\n\njobs:\n  markscribe:\n    runs-on: ubuntu-latest\n\n    steps:\n      - uses: actions/checkout@master\n\n      - uses: muesli/readme-scribe@master\n        env:\n          GITHUB_TOKEN: ${{ secrets.PERSONAL_GITHUB_TOKEN }}\n        with:\n          template: \"templates/README.md.tpl\"\n          writeTo: \"README.md\"\n\n      - uses: stefanzweifel/git-auto-commit-action@v4\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n        with:\n          commit_message: Update generated README\n          branch: main\n          commit_user_name: readme-scribe 🤖\n          commit_user_email: actions@github.com\n          commit_author: readme-scribe 🤖 \u003cactions@github.com\u003e\n```\n\nCareful: if you use `master` instead of `main` as the default branch, you will\nneed to update the above config for `git-auto-commit-action` accordingly.\n\nThis action will be triggered once per hour, parses `templates/README.md.tpl`\nand generates a new `README.md` for you, and eventually pushes the changes to\nthe `master` branch. Make sure to adjust the input values `template` and\n`writeTo` to suit your needs.\n\n## Example output\n\n![readme-scribe example output](https://github.com/muesli/readme-scribe/raw/master/assets/template_example.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuesli%2Freadme-scribe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmuesli%2Freadme-scribe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuesli%2Freadme-scribe/lists"}