{"id":28377252,"url":"https://github.com/harunrst/reading-time-action","last_synced_at":"2026-04-13T23:32:47.689Z","repository":{"id":126004780,"uuid":"600039690","full_name":"harunrst/reading-time-action","owner":"harunrst","description":"Reading time action calculates medium-like reading times of markdown files in your repository and inserts them to the top of your markdown files.","archived":false,"fork":false,"pushed_at":"2023-05-12T10:05:00.000Z","size":773,"stargazers_count":3,"open_issues_count":5,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-06T01:23:22.012Z","etag":null,"topics":["actions","github","github-actions","markdown","reading-time"],"latest_commit_sha":null,"homepage":"","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/harunrst.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":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-10T12:57:28.000Z","updated_at":"2023-02-24T16:31:59.000Z","dependencies_parsed_at":"2023-06-09T01:00:23.261Z","dependency_job_id":null,"html_url":"https://github.com/harunrst/reading-time-action","commit_stats":{"total_commits":19,"total_committers":3,"mean_commits":6.333333333333333,"dds":0.3157894736842105,"last_synced_commit":"789474201a73796c0d1e5365878ff3d59a136502"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":"actions/typescript-action","purl":"pkg:github/harunrst/reading-time-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harunrst%2Freading-time-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harunrst%2Freading-time-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harunrst%2Freading-time-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harunrst%2Freading-time-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/harunrst","download_url":"https://codeload.github.com/harunrst/reading-time-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harunrst%2Freading-time-action/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260774852,"owners_count":23060943,"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":["actions","github","github-actions","markdown","reading-time"],"created_at":"2025-05-30T01:04:20.538Z","updated_at":"2026-04-13T23:32:42.658Z","avatar_url":"https://github.com/harunrst.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp id=\"reading-time-action-id\" align=\"left\"\u003e2 min read\u003c/p\u003e\n\n# GitHub Action to Calculate \u0026 Insert Reading Time\n\n\u003ca href=\"https://github.com/harunrst/reading-time-action/actions\"\u003e\u003cimg alt=\"typescript-action status\" src=\"https://github.com/harunrst/reading-time-action/workflows/build-test/badge.svg\"\u003e\u003c/a\u003e\n\nReading time action calculates medium-like reading times of markdown files in your repository and prepends them to the top of your markdown files.\n\n![](./assets/example_view.jpg)\n\nYou can;\n\n- Pick your calculation strategy: only readme file, specific paths, and all markdown files.\n- Pick your style: regular/bold text, align it to left/center/right.\n- Merge and run as you wish;\n  - Run on push / manually: get auto-generated PR to your markdown files or push to your branch.\n  - Run on pull-request: update your pull request with calculated times.\n  - Or do whatever you wish to do with the updated markdowns :)\n\n## Usage\n\nAll examples below are triggered only when you make a change on a markdown file. To trigger for the first time, I suggest you run manually using `workflow_dispatch`\n\n## Inputs\n\n- **strategy**: `readme`(default), `paths`(requires 'paths' input), `all`\n- **paths**: i.e `docs`, `docs|src/marks`\n- **text-style**: `default`(default), `bold`\n- **text-align**: `left`(default), `center`, `right`\n\n### Example Workflow File\n\nUpdates readme and works on push / manually and creates pull-request. On push triggers only if there is a change on readme file.\n\n```yaml\nname: Reading Time\n\non:\n  workflow_dispatch:\n  push:\n    branches:\n      - main\n    paths:\n      - '**.md'\n\njobs:\n  calculate-reading-time:\n    runs-on: ubuntu-latest\n    name: Calculate Reading Time\n    permissions:\n      contents: write\n      pull-requests: write\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v3\n\n      - name: Calculate \u0026 Prepend Reading Time\n        uses: harunrst/reading-time-action@v1.0\n        with:\n          strategy: readme\n          text-style: default\n\n      # Example with paths strategy\n      # - name: Calculate \u0026 Prepend Reading Time\n      #   uses: harunrst/reading-time-action@v1.0\n      #   with:\n      #     strategy: paths\n      #     paths: docs|files\n      #     text-style: default\n\n      - name: Commit Changes\n        uses: EndBug/add-and-commit@v9\n        with:\n          message: Edited markdown files with reading times.\n          push: false\n\n      # !! Allow GitHub Actions to create pull-request from settings in your repository\n      - name: Create Pull Request\n        uses: peter-evans/create-pull-request@v4\n        with:\n          title: Update markdown files with reading time.\n          body: Auto-generated Pull Request by [reading-time-action](https://github.com/harunrst/reading-time-action).\n          branch: reading-time-action\n\n      # Example Push Changes\n      # - name: Push changes\n      #   uses: ad-m/github-push-action@master\n      #   with:\n      #     github_token: ${{ secrets.GITHUB_TOKEN }}\n      #     branch: ${{ github.ref }}\n```\n\n![](./assets/pull_request.jpeg)\n\n### Example Repositories\n\n- [Progressium-API](https://github.com/harunrst/Progressium-Api)\n\n- [Essentials-of-Being-a-Software-Engineer](https://github.com/harunrst/Essentials-of-Being-a-Software-Engineer)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharunrst%2Freading-time-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fharunrst%2Freading-time-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharunrst%2Freading-time-action/lists"}