Top-Langauges - Readme

Add development language usage statistics on your Profile Readme.

Did not need to fork this repository.

Usage

1. Go to your Profile Readme

2. move to <username>/<username>/actions

3. Click New workflow

4. Set up a workflow yourself

5. Delete the default content

6. copy the following code and paste it to your new workflow

   name: Top-Languages Readme
   
   on:
       workflow_dispatch:
       schedule:
           # Runs at 12am UTC
           - cron: '0 0 * * *'
   
   jobs:
       update-readme:
           name: Update this repo's README
           runs-on: ubuntu-latest
           steps:
           - uses: ryuanerin/top-languages-readme@master

7. Add a comment to your README.md like this:

   <!--START_SECTION:top_language-->
   <!--END_SECTION:top_language-->

8. Go to Action menu

9. Click Top-Languages Readme under All workflows

10. Click Run workflow

Including private repository

1. Move to Github Settings -> Developer settings -> Personal access tokens -> Generate new token

2. Check repo

3. Click generate token

4. Copy token

   

5. Go to your Profile Readme

6. Move to Settings -> Secrets

7. Click New Secret

8. input GH_TOKEN in Name

9. input the copied token in Value

10. Click Add secret

11. Edit you workflow file

    name: Top-Languages Readme
    
    on:
        workflow_dispatch:
        schedule:
            # Runs at 12am UTC
            - cron: '0 0 * * *'
    
    jobs:
        update-readme:
            name: Update this repo's README
            runs-on: ubuntu-latest
            steps:
            - uses: ryuanerin/top-languages-readme@master
              with:
                GH_TOKEN: ${{ secrets.GH_TOKEN }}

With option (Optional)

name: Top-Languages Readme

on:
    workflow_dispatch:
    schedule:
        # Runs at 12am UTC
        - cron: '0 0 * * *'

jobs:
    update-readme:
        name: Update this repo's README
        runs-on: ubuntu-latest
        steps:
        - uses: ryuanerin/top-languages-readme@master
          with:
            COMMIT_MESSAGE: "Updated the Graph with new Metrics" # Optional
            USERNAME: <username> # Optional
            LINE_FORMAT: "$NAME   $SIZE $BAR  $PERCENT" # Optional
            LIST_COUNT: 10 # Optional
            BLOCKS: "░█" # Optional
            BAR_WIDTH: 25 # Optional
            SHOW_TOTAL: false # Optional
            TOP_TOTAL: false # Optional
            SHOW_TOTAL_SEPARATOR: true # Optional

• BLOCKS styles:

  • default : ░█

  BLOCKS	default	example (55.5%)
  █	O	██████
  ░█		██████░░░░
  ░▒▓█		█████▓░░░░
  ⣀⣄⣤⣦⣶⣷⣿		⣿⣿⣿⣿⣿⣶⣀⣀⣀⣀
  ⣀⣄⣆⣇⣧⣷⣿		⣿⣿⣿⣿⣿⣧⣀⣀⣀⣀
  ▁▂▃▄▅▆▇█		█████▅▁▁▁▁
  ▏▎▍▌▋▊▉█		█████▋▏▏▏▏
  ○◔◐◕⬤		⬤⬤⬤⬤⬤◕○○○○
  □◱◧▣■		■■■■■▣□□□□
  □◱▨▩■		■■■■■▩□□□□
  □▨▩■		■■■■■▩□□□□
  □◱▥▦■		■■■■■▦□□□□