1. You need to update the markdown file(.md) with the START_SECTION and STOP_SECTION comments. You can refer this section for updating it.

2. You'll need a GitHub API Token with repo and user scope from here if you're running the action to get commit metrics

enabling the repo scope seems DANGEROUS
but this GitHub Action only accesses your commit timestamp and lines of code added or deleted in repository you contributed.

3. 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=<your github access token>

4. You can enable and disable feature flags based on requirements. See this.

5. For the final step you need to add an .yml file in your workflows folder. You can copy/paste this example file and enable/disable flags as you wish!.

GH_TOKEN Your GitHub token explainer in Step 2.
TIMEZONE Your timezone, defaults to "Asia/Kolkata" for India.

Add a comment to your README.md like this:

<!--START_SECTION:readme-info-->
<!--END_SECTION:readme-info-->

See this example file. You can put these Entry Points anywhere and in any order you please! 🤷‍♂️

SHOW_LINES_OF_CODE flag can be set to True to show the Lines of code writen till date

From Hello World I have written 1.6 million Lines of Code ✍️

SHOW_PROFILE_VIEWS flag can be set to False to hide the Profile views

✨ 216 people were here!

SHOW_DAILY_COMMIT flag can be set to False to hide the commit stat

I'm a night 🦉

🌞 Morning    57 commits     ████░░░░░░░░░░░░░░░░░░░░░   16.76%
🌆 Daytime    85 commits     ██████░░░░░░░░░░░░░░░░░░░   25.0%
🌃 Evening    128 commits    █████████░░░░░░░░░░░░░░░░   37.65%
🌙 Night      70 commits     █████░░░░░░░░░░░░░░░░░░░░   20.59%

SHOW_WEEKLY_COMMIT flag can be set to False to hide the commit stat

📅 I'm Most Productive on Mondays

Monday       64 commits     █████░░░░░░░░░░░░░░░░░░░░   21.19%
Tuesday      33 commits     ██░░░░░░░░░░░░░░░░░░░░░░░   10.93%
Wednesday    59 commits     █████░░░░░░░░░░░░░░░░░░░░   19.54%
Thursday     41 commits     ███░░░░░░░░░░░░░░░░░░░░░░   13.58%
Friday       40 commits     ███░░░░░░░░░░░░░░░░░░░░░░   13.25%
Saturday     35 commits     ███░░░░░░░░░░░░░░░░░░░░░░   11.59%
Sunday       30 commits     ██░░░░░░░░░░░░░░░░░░░░░░░   9.93%

SHOW_LANGUAGE flag can be set to False to hide the Number of repository in different language and framework

My 💖 languages Python

Python      12 repos █████████████░░░░░░░░░░░░ 54.55%
JavaScript   7 repos ████████░░░░░░░░░░░░░░░░░ 31.82%
CSS          2 repos ██░░░░░░░░░░░░░░░░░░░░░░░ 9.09%
HTML         1 repos █░░░░░░░░░░░░░░░░░░░░░░░░ 4.55%

SHOW_TOTAL_CONTRIBUTIONS flag can be set to False to hide the total Number of Contributions

🏆 531 Contributions in year 2020

matchai/awesome-pinned-gists
athul/waka-readme
anmol098/waka-readme-stats

Liked this Project? Why not 🌟 it?

Made with 🖤 by Jainam Desai