https://github.com/kdn0325/terminal-for-github-profile-readme

https://github.com/kdn0325/terminal-for-github-profile-readme

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/kdn0325/terminal-for-github-profile-readme
• Owner: kdn0325
• License: mit
• Created: 2024-03-13T12:05:23.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-30T03:00:55.000Z (7 months ago)
• Last Synced: 2024-10-30T06:12:11.298Z (7 months ago)
• Language: JavaScript
• Size: 158 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
GitHub Stats Terminal Style

Dynamically Generate GitHub Stats as like Terminal Interface 




  

    

  





  



## Usage

1. Create a New Repository using this Template or click [here](https://github.com/yogeshwaran01/github-stats-terminal-style/generate) to create.

2. Create the personal Acess token. Checkout this [link](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create personal access token.

3. Add a New Repository secret to your repo. Name of the secret is must be `GHT` and valve is your personal access token. Checkout this [link](https://docs.github.com/en/actions/reference/encrypted-secrets) to add new repositiry secret.

The File `github_stats.svg` is svg image of your github stats. you can copy the link of the image and use it any where. By default it update daily at `2:47 UTC` you can also can this by change the cron in `/.github/workflows/main.yml` by using [Cron Generator](https://crontab.guru/).

## Themes

Now only Nine themes are only available. By default, ubuntu theme. you can change the theme by change the command in file `/.github/workflows/main.yml`.

```bash

node updater.js ${{ github.repository_owner }} 

```

For random theme, need not to mention any arguments

|                           **Theme Sample**                            | **Theme Name** |         **Theme Sample**        |  **ThemeName** |

| :-------------------------------------------------------------------: | :------------: | :------------------------------:| :-------------: |

|            |     ubuntu     |   |   hacker   |

|                |      atom      |   |   googledark   |

|          |    default     |  |  googlelight   |

|          |    dracula     |      |    monokai     |

|            |     github     |   |   powershell   |

## Contributions

Contributions, issue and pull requests are welcome

## Credits

Svg Generated from [termtosvg](https://github.com/nbedos/termtosvg)