How To Create An Amazing GitHub Profile README

🛠 Customizing GitHub profile with README.md file

Hey Developers,

Today I 'am going to show you how to make your README file looks Amazing am going to talk how to add automated feeds of blog posts and Github stats.

Customizing your Github profile page with a README file is as simple as creating a repo that is named the same as your username. For example, my GitHub username is aljagne so I created a new repository with the name aljagne. Note: at the time of this writing, in order to access the profile README feature, the letter-casing must match your GitHub username.

• 1. Create a new repository with the same name (including casing) as your GitHub username: https://github.com/new and make sure is public, not private
• 2. Create a README.md file inside the new repo with content (text, GIFs, images, emojis, etc.)
• 3. Commit your fancy new README! ○ If you're on GitHub's web interface you can choose to commit directly to the repo's main branch (i.e., master or main) which will make it immediately visible on your profile)
• 4. Push changes to GitHub (if you made changes locally i.e., on your computer and not github.com).
• 5. Adding a list of blog posts to do this am going to use a github action called blog post workflow, and this was created by Gautam krishna R, and a link to the repo will be in here. And to use it you need to add this blog post list start and end comment <!-- BLOG-POST-LIST:START --><!-- BLOG-POST-LIST:END --> to your README file so the github action workflow will add the actual blog posts in between the comments you paste. after that, you need to create a folder named .github and within that, another folder called workflows and within that, you will create a yml file and paste in this

name: Latest blog post workflow
on:
  schedule:
    # Runs every hour
    - cron: '0 * * * *'
  workflow_dispatch:

jobs:
  update-readme-with-blog:
    name: Update this repo's README with latest blog posts
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: gautamkrishnar/blog-post-workflow@master
        with:
          feed_list: "https://dev.to/feed/aljagne"

feed_list: is where you give it your list of blog posts.
go back to github now that you have added that you'll see on your github page latest blog posts and there will be no posts yet, go back to your repo and then go to actions, no actions have been run yet you'll see your new workflow click on the workflow and run your workflow manually it will take some seconds, and now go back to your profile and refresh you will have your list of blog posts.

• 6. Adding github stats for this, you can use github-readme-stats created by Anurag Hazra, is an awesome repo here and it's very simple to implement it doesn't require any actions you just need to add a simple line of code to your README file

<img align="left" alt="aljagne's Github Stats" src="https://github-readme-stats.vercel.app/api?username=aljagne&show_icons=true&hide_border=true" />

and then api username= so you want your github username to be where aljagne is, replace it with yours.
I've got a couple of options here show icon set to true and hide border set to true and save it, now go back to your github profile and refresh you will see your github stats.
you can go to the repo there's a lot you can actually do with it.

---

I've been inspired by the creative READMEs I've seen so far and am looking forward to seeing all kinds of profiles in the upcoming weeks months.

---

Thanks for reading "How To Create An Amazing GitHub Profile README". Join me on twitter for the newest web development content, my thoughts on the web and learn about exclusive opportunities.