{"id":13910687,"url":"https://github.com/th3c0d3br34ker/github-readme-info","last_synced_at":"2025-07-18T09:32:34.300Z","repository":{"id":37402895,"uuid":"286431308","full_name":"th3c0d3br34ker/github-readme-info","owner":"th3c0d3br34ker","description":"✨ This GitHub action helps to add cool Stats to your GitHub profile README.","archived":false,"fork":false,"pushed_at":"2023-01-12T16:15:54.000Z","size":59,"stargazers_count":71,"open_issues_count":2,"forks_count":24,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-14T13:51:42.940Z","etag":null,"topics":["github","github-actions","readme"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/github-readme-generator","language":"Python","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/th3c0d3br34ker.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-08-10T09:25:41.000Z","updated_at":"2024-11-03T21:19:00.000Z","dependencies_parsed_at":"2023-02-09T12:35:13.984Z","dependency_job_id":null,"html_url":"https://github.com/th3c0d3br34ker/github-readme-info","commit_stats":{"total_commits":49,"total_committers":2,"mean_commits":24.5,"dds":"0.16326530612244894","last_synced_commit":"bcfc423b183884a96dc5bbb6e84de38b4985bea5"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/th3c0d3br34ker%2Fgithub-readme-info","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/th3c0d3br34ker%2Fgithub-readme-info/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/th3c0d3br34ker%2Fgithub-readme-info/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/th3c0d3br34ker%2Fgithub-readme-info/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/th3c0d3br34ker","download_url":"https://codeload.github.com/th3c0d3br34ker/github-readme-info/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226388703,"owners_count":17617320,"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":["github","github-actions","readme"],"created_at":"2024-08-07T00:01:42.123Z","updated_at":"2024-11-25T19:31:40.864Z","avatar_url":"https://github.com/th3c0d3br34ker.png","language":"Python","funding_links":[],"categories":["Python","🛠️ Widgets 👇"],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e✨README Info Generator ✨\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://img.shields.io/badge/Made%20with-Python-blue.svg\"/\u003e\n\u003cimg src=\"https://img.shields.io/badge/Made%20with-Markdown-black.svg\"/\u003e\n\u003cimg src=\"https://img.shields.io/github/license/th3c0d3br34ker/github-readme-info\"/\u003e\n\u003cimg src=\"https://img.shields.io/github/stars/th3c0d3br34ker/github-readme-info\"/\u003e\n\u003cimg src=\"https://img.shields.io/github/forks/th3c0d3br34ker/github-readme-info\"/\u003e \n\u003cimg src=\"https://img.shields.io/static/v1?label=%F0%9F%8C%9F\u0026message=this%20Repository\u0026style=style=flat\u0026color=blue\" alt=\"Star Badge\"/\u003e\n\u003cimg src=\"https://app.codacy.com/project/badge/Grade/282ae5620b4140c99a0c5f4b8e6a362a\"/\u003e\n\u003c/p\u003e\n\n\u003cspan align=\"center\"\u003e\n\nFlex your Stats with this highly customizable tool!\u003cbr/\u003e\nAre you an early 🐤 or a night 🦉?\u003cbr/\u003e\nWhen are you most productive during the day?\u003cbr/\u003e\nWhat are languages you code in?\u003cbr/\u003e\n\n\u003c/span\u003e\n\n## Setup\n\n1.  You need to update the markdown file(.md) with the `START_SECTION` and `STOP_SECTION` comments. You can refer [this](#entry-points) section for updating it.\n\n2.  You'll need a GitHub API Token with `repo` and `user` scope from [here](https://github.com/settings/tokens) if you're running the action to get commit metrics\n\n\u003e enabling the `repo` scope seems **DANGEROUS**\u003cbr/\u003e\n\u003e but this GitHub Action only accesses your commit timestamp and lines of code added or deleted in repository you contributed.\n\n3.  You need to save the GitHub API Token in the repository secrets. You can find that in the Settings of your repository. Be sure to save those as GitHub Personal Access Token as `GH_TOKEN=\u003cyour github access token\u003e`\n\n4.  You can enable and disable feature flags based on requirements. See [this](#flags-available).\n\n5.  For the final step you need to add an `.yml` file in your workflows folder. You can copy/paste [this](./example/readme-info-schedule.yml) example file and enable/disable flags as you wish!.\n\n### The Required fields are\n\n\u003e GH_TOKEN Your GitHub token explainer in Step 2.  \n\u003e TIMEZONE Your timezone, defaults to \"Asia/Kolkata\" for India.\n\n### Entry Points\n\nAdd a comment to your `README.md` like this:\n\n```md\n\u003c!--START_SECTION:readme-info--\u003e\n\u003c!--END_SECTION:readme-info--\u003e\n```\n\nSee this example [file](./example/README.md). You can put these Entry Points anywhere and in any order you please! 🤷‍♂️\n\n## Flags Available\n\n`SHOW_LINES_OF_CODE` flag can be set to `True` to show the Lines of code writen till date\n\n```text\nFrom Hello World I have written 1.6 million Lines of Code ✍️\n```\n\n`SHOW_PROFILE_VIEWS` flag can be set to `False` to hide the Profile views\n\n```text\n✨ 216 people were here!\n```\n\n`SHOW_DAILY_COMMIT` flag can be set to `False` to hide the commit stat\n\n```text\nI'm a night 🦉\n\n🌞 Morning    57 commits     ████░░░░░░░░░░░░░░░░░░░░░   16.76%\n🌆 Daytime    85 commits     ██████░░░░░░░░░░░░░░░░░░░   25.0%\n🌃 Evening    128 commits    █████████░░░░░░░░░░░░░░░░   37.65%\n🌙 Night      70 commits     █████░░░░░░░░░░░░░░░░░░░░   20.59%\n\n```\n\n`SHOW_WEEKLY_COMMIT` flag can be set to `False` to hide the commit stat\n\n```text\n📅 I'm Most Productive on Mondays\n\nMonday       64 commits     █████░░░░░░░░░░░░░░░░░░░░   21.19%\nTuesday      33 commits     ██░░░░░░░░░░░░░░░░░░░░░░░   10.93%\nWednesday    59 commits     █████░░░░░░░░░░░░░░░░░░░░   19.54%\nThursday     41 commits     ███░░░░░░░░░░░░░░░░░░░░░░   13.58%\nFriday       40 commits     ███░░░░░░░░░░░░░░░░░░░░░░   13.25%\nSaturday     35 commits     ███░░░░░░░░░░░░░░░░░░░░░░   11.59%\nSunday       30 commits     ██░░░░░░░░░░░░░░░░░░░░░░░   9.93%\n\n```\n\n`SHOW_LANGUAGE` flag can be set to `False` to hide the Number of repository in different language and framework\n\n```text\nMy 💖 languages Python\n\nPython      12 repos █████████████░░░░░░░░░░░░ 54.55%\nJavaScript   7 repos ████████░░░░░░░░░░░░░░░░░ 31.82%\nCSS          2 repos ██░░░░░░░░░░░░░░░░░░░░░░░ 9.09%\nHTML         1 repos █░░░░░░░░░░░░░░░░░░░░░░░░ 4.55%\n\n```\n\n`SHOW_TOTAL_CONTRIBUTIONS` flag can be set to `False` to hide the total Number of Contributions\n\n```text\n🏆 531 Contributions in year 2020\n```\n\n### Inspired By 🚀\n\n\u003e [matchai/awesome-pinned-gists](https://github.com/matchai/awesome-pinned-gists)  \n\u003e [athul/waka-readme](https://github.com/athul/waka-readme)  \n\u003e [anmol098/waka-readme-stats](https://github.com/anmol098/waka-readme-stats)\n\n```text\nLiked this Project? Why not 🌟 it?\n```\n\n\u003e Made with 🖤 by Jainam Desai\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fth3c0d3br34ker%2Fgithub-readme-info","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fth3c0d3br34ker%2Fgithub-readme-info","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fth3c0d3br34ker%2Fgithub-readme-info/lists"}