Skip to main content

Setting up GitHub Profile README

Updated Nov 22, 2023 ·

Create the Repository​

  1. In your Github account, go to Repositories > New

  2. Enter a repository name that is the same as your username. Notice that a message will appear below it saying that this will be a special repository.

  3. Tick the Add a README file box.

  4. Click Create repository.

  5. Once created, it should appear at the top of your profile now. You can proceed to the next sections to learn how to customize it.

Adding Header​

I initially played around with headers on my Github profile README, but ended up removing it instead as I want a more simplified look.

If you want to explore headers, see the links below:

Connect with me​

We can set up the "Connect with me" section using icons from Simple Icons. Another way is to download the SVG icons and then reference them in your Github profile readme.

Here is an example in markdown:

## Connect with me

[![website](./Images/twitter-light.svg)](https://twitter.com/eden_noel08#gh-light-mode-only)
[![website](./Images/twitter-dark.svg)](https://twitter.com/eden_noel08#gh-dark-mode-only)
  

Another way to customize this section is to use shields.io. As an example, we can search for X (Twitter) and customize the values. Click Execute to see the preview at the bottom.

Once done, copy the Markdown URL and use it on your Github README file.

## Connect with me

[![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/eden_noel08?style=for-the-badge&logo=twitter&label=Twitter&labelColor=f3f7fa&color=1D9BF0)][twitter]

Other badges:

Github Stats​

Reference: anuraghazra/github-readme-stats

  1. In Github, go to Settings > Developer settings > Personal access tokens.

  2. Click Generate new token.

  3. Enter a name and then click Generate token at the bottom.

  4. Copy the token and save it. This will be the only time you'll see the token in this page.

  5. Go to vercel.com and sign up using your Github account.

  6. Go to Github and search for the anuraghazra/github-readme-stats repo. Fork it.

  7. Copy the URL of the forked repository.

    https://github.com/joseeden/github-readme-stats

  8. Go back to Vercel and import repository > Add Github account.

  9. In the new window, click Only seelct repositories > choose the forked repository > Install.

  10. Click Import.

  11. Click Environment Variables. Enter "PAT_1" as the Key and paste the Github token (generated in step 2) in the Value field. Click Add > Deploy.

  12. We should see the Congratulations page once done. Click Conttinue to dashboard.

  13. Copy the domain provided.

    github-readme-stats-blond-theta-24.vercel.app

  14. Go back to your Github profile README file and add the following.


    ## Github Stats 

    <!-- This section shows "Github Stats" -->

    <a href="https://github.com/joseeden/joseeden">
    <img align="center" src="https://github-readme-stats-blond-theta-24.vercel.app/api?username=joseeden&show_icons=true&count_private=true&theme=radical&hide_border=true&bg_color=f3f7fa&text_color=000000&title_color=012e95&icon_color=012e95&border_color=012e95&card_width=400&line_height=25"/>


    <!-- This section shows "Most Used Languages" -->

    <a href="https://github.com/joseeden/joseeden">
    <img align="center" src="https://github-readme-stats.vercel.app/api/top-langs/?username=joseeden&hide=java,html&theme=radical&layout=compact&langs_count=8&hide_border=true&bg_color=f3f7fa&text_color=000000&title_color=012e95&icon_color=012e95&border_color=012e95&card_width=400&line_height=25"/>

Recent Github Activity​

Full instructions can be found in the link below:

References​