DEV Community

Cover image for How To Create A GitHub Profile README

How To Create A GitHub Profile README

Monica Powell on July 11, 2020

GitHub recently released a feature that allows users to create a profile-level README to display prominently on their GitHub profile. This article ...
Collapse
sarehprice profile image
Sarah Price

I saw someone post theirs the other day with a fun animation. I hadn't realized this was a new feature so I thought they were just joking around. But this is great! I'm going to have to do some brainstorming on mine. Maybe I'll see how much of my design skills I can use in it as well!

Collapse
coderjojo profile image
coderjojo

I have created Developer Profile repository with a bunch of GitHub profiles so that others will get inspiration to create their own. Do consider to contribute with your profile also.

Collapse
itsasine profile image
ItsASine (Kayla)

Only downside I can see to this is that the README seems meant to be a living document. Mine is a bunch of gifs now, but later I could update it to actually be professional or something and less awesome.

Collapse
coderjojo profile image
coderjojo

You may update it later in the repo also.

Thread Thread
itsasine profile image
ItsASine (Kayla)

I see screenshots got added recently, nice! :)

Collapse
ayushkumar25 profile image
Ayush Kumar • Edited


My Github.
For more cool templates.

Collapse
jacques_blom profile image
Jacques Blom • Edited

I've set mine up to automatically pull in my latest uploads from YouTube, using a Netlify Serverless function:
github.com/jacques-blom
screenshot

Collapse
rahuldkjain profile image
Rahul Jain

Tired of updating GitHub profle README with latest features again & again?

If yes, then I have developed a tool to do the same for you in just 1 click ๐Ÿค“

๐Ÿš€ Try the tool: live tool

If you find the tool useful, show some love by giving a โญ on github repo

GitHub logo rahuldkjain / github-profile-readme-generator

๐Ÿš€ Generate GitHub profile README easily with the latest add-ons like visitors count, GitHub stats, etc using minimal UI.

GitHub Profile Readme Generator

GitHub Profile README Generator

github-profile-readme-generator license github-profile-readme-generator forks github-profile-readme-generator stars github-profile-readme-generator issues github-profile-readme-generator pull-requests join discord community of github profile readme generator

github-profile-readme-generator gif

View Demo ยท Report Bug ยท Request Feature

Loved the tool? Please consider donating ๐Ÿ’ธ to help it improve!

sponsor github profile readme generator Buy Coffee for rahuldkjain Buy Me A Coffee

Tired of editing GitHub Profile README with new features?

This tool provides an easy way to create a GitHub profile readme with the latest add-ons such as visitors count, github stats, etc.

๐Ÿš€ Demo

Try the tool: GitHub Profile README Generator

๐Ÿง Features

Just fill in the details such as Name, Tagline, Dev Platforms Username, Current Work, Portfolio, Blog, etc. with a minimal UI.

  • Uniform Dev Icons

  • Uniform Social Icons

  • Visitors Counter Badge

  • GitHub Profile Stats Card

  • GitHub Top Skills

  • GitHub Streak Stats

  • Dynamic Dev(.)to Blogs (GitHub Action)

  • Dynamic Medium Blogs (GitHub Action)

  • Dynamic Personal Blogs from RSS Feed (GitHub Action)

  • Wakatime Stats contribute

  • Buy Me A Coffee button

Click on Generate README to get your README in markdownโ€ฆ

Collapse
sanchitbajaj02 profile image
Sanchit Bajaj

It's great and easy to use

Collapse
alenabraham profile image
Alen Abraham

hey, I tried out this.
It's an awesome tool. Nice one mate.

Collapse
vadorequest profile image
Vadorequest • Edited

Just built mine in 2h time really quickly, with github stats, trophies, SO feed, medium feed, etc.

github.com/Vadorequest

Thanks to github.com/rahuldkjain/github-prof... which helped me bootstrap real quick!

Collapse
israelias profile image
Joem Elias Sanez

Great piece. Newbie, but took a friendly first pass at this โ€” bonus CV frontier!
mine

Collapse
arturssmirnovs profile image
Arturs Smirnovs

You inspired me to make my own readme and make this open source project #justforfun that allows you to generate github readme files: arturssmirnovs.github.io/github-pr...

Collapse
10secondsofcode profile image
Elango Sundar

I have created a repository for awesome github profile aims to collect the all awesome beautiful READMEs profile and make your Profile look good & Inspire other's.

Collapse
punitkmryh_93 profile image
Punitkumar Y Harsoor • Edited

I did my own have a look:
Github Profile /punitkmryh

Collapse
odalet profile image
odalet

Hi! Do you know if this is also available to organizations?

Collapse
ileriayo profile image
Ileriayo Adebiyi

This feature may be that solution for

  • a website (sort of); a win-win for you if you
  • write your blogs in markdown, push to GitHub and publish on dev.to,,
  • one more thing, custom domain.

Thanks for sharing Monica!

Collapse
harshalrj25 profile image
harshal jadhav • Edited

Here's mine which shows your latest medium blogs.
harshalrj25

checkout my repo github.com/harshalrj25/mediumblog-... to add medium blogs to your profile.

Collapse
imshravan profile image
Shravan Kumar B

Hi, do check this project, to beautify your profile readme. Star it, if you like it.

GitHub Dynamic Animated Quote Generator

GitHub logo shravan20 / github-readme-quotes

Dynamic quote generator for your GitHub readmes

github-readme-quotes

Dynamic quote generator for your GitHub readmes

banner

alt PRs Welcome Open Source? Yes! GitHub contributors Pull Request Counts last commit deployment-status community chat

Github Readme Quotes

Copy and paste the following markdown content to display the quote.

![Quote](https://github-readme-quotes.herokuapp.com/quote)
Enter fullscreen mode Exit fullscreen mode

Themes

You can display your quote in different themes without any manual customization.

Use ?theme=THEME_NAME parameter as shown below.

![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark)
Enter fullscreen mode Exit fullscreen mode

Available Themes

dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula

Gotham

Quote

Dark

Quote

Light Theme

Quote

You can explore different themes here.

Feel free to contribute different themes.

Layouts

You can also change the layout of your templates.

Use ?layout=LAYOUT parameter as shown below

![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark&layout=socrates)
Enter fullscreen mode Exit fullscreen mode

Layout 1 (Default)

Quote

Layout 2 (Socrates)

Quote

You can explore different layouts here.

Feel free to contribute different layouts.

Animations

You can also add animations to your templates.

Use ?animation=ANIMATION paramater as shown below

![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark&animation=grow_out_in)
Enter fullscreen mode Exit fullscreen mode

Animation 1

Quote

You can explore different animationsโ€ฆ

Collapse
kkvanonymous profile image
Kunal Kumar Verma

This inspired me to make my own Github readme profile.
Thx for the same :)
Here's the link : Github

Collapse
jamesgeorge007 profile image
James George

I've built a GitHub Action that updates README with the recent activity of a user.

GitHub logo jamesgeorge007 / github-activity-readme

Updates README with the recent GitHub activity of a user

GitHub Activity in Readme

Updates README.md with the recent GitHub activity of a user.

profile-repo


Instructions

  • Add the comment <!--START_SECTION:activity--> (entry point) within README.md. You can find an example here.

  • It's the time to create a workflow file.

.github/workflows/update-readme.yml

name: Update README

on:
  schedule:
    - cron: '*/30 * * * *'
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    name: Update this repo's README with recent activity

    steps:
      - uses: actions/checkout@v2
      - uses: jamesgeorge007/github-activity-readme@master
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Enter fullscreen mode Exit fullscreen mode

The above job runs every half an hour, you can change it as you wish based on the cron syntax.

Please note that only those public events that belong to the following list show up:-

  • IssueEvent
  • IssueCommentEvent
  • PullRequestEvent

You can find an example here.

Override defaults

Use the following input params to customize it forโ€ฆ

Collapse
baalkrshna profile image
Puneet Gopinath

Hey James George, you no longer maintain it. So here is a fork of it to use instead:

GitHub logo Readme-Workflows / recent-activity

Add your recent activity to your profile readme!

Recent Activity

GitHub stars GitHub forks GitHub issues GitHub repo size Lines of code Discord Chat Contributor Covenant

This GitHub Action is a Fork of the original GitHub Activity Readme Action by jamesgeorge007.
Its our goal is to improve the original GitHub Action while also providing new features for the users.

Live Preview

This is an example live preview that is updated every time a commit is pushed using github actions.

Last Updated: Thursday, May 20th, 2021, 3:17:39 PM (GMT)

  1. โ—๏ธ Closed issue #5 in Readme-Workflows/recent-activity
  2. ๐ŸŽ‰ Merged PR #6 in Readme-Workflows/recent-activity
  3. ๐Ÿ—ฃ Commented on #3 in Readme-Workflows/recent-activity
  4. โ—๏ธ Closed issue #4 in Readme-Workflows/recent-activity
  5. ๐Ÿ’ช Opened PR #6 in Readme-Workflows/recent-activity

Settings

The Action currently has the following Settings that you can set through the with option.

Option Description Default Supported Placeholder
GH_USERNAME The User to get latest activity from Repository Owner
COMMIT_MSG The Commit Message to use when updating the README โšก Update README with the recent activity
MAX_LINES How many activities to display 5
โ€ฆ
Collapse
vindiv profile image
Vincenzo Di Vico

After reading this article i've created my readme. it's a work in progress and i'll update it, but i'm happy of the result. i've used an animation of me in my real office in flat style and with this avatar. next time i'll "upgrade" the animation with more element

Collapse
aayushidroid profile image
Aayushi Sharma

Hi there ๐Ÿ‘‹

I am aayushi Sharma. I Love โค๏ธ programming and currently working as Machine learning engineer.

Language & Skills

  • Python
  • C++
  • JavaScipt
  • Web Development
  • Machine Learning
  • Deep learning
  • Natural language processing
  • App Development

Things got bugs, gonna smash them one by one

aayushi-droid






Collapse
rdnine profile image
Rafael Duarte

What a nice feature!

This is going to my to-do for future build!

Thanks ๐Ÿ‘

Collapse
king11 profile image
Lakshya Singh

I made mine after seeing this post thanks a lot.

My Readme : Profile

Collapse
rodrigograca31 profile image
Rodrigo Graรงa ๐Ÿ‘จ๐Ÿปโ€๐Ÿ’ป๐Ÿ›

Not wanting to plug my self but I think my profile also looks pretty nice and has a few easter eggs:
github.com/rodrigograca31

Collapse
zeecnla profile image
Cesar Melchor

Thanks for this! I had no idea ๐Ÿคฏ. I have to think about how creative to make mine!

Collapse
anitajoseph profile image
Anita Joseph

Thanks for the steps to be followed ans also the exemples.

Collapse
caffiendkitten profile image
DaNeil C

This is such an underused feature. Thanks for sharing it!

Collapse
mridul037 profile image
mridul037 • Edited
Collapse
dennislwm profile image
dennislwm

My profile: yourls.fxgit.work/a005

Learn to use GitHub for Python and send Actions to Telegram Bot.

yourls.fxgit.work/a001

python #telegram

Collapse
hemant profile image
Hemant Joshi ๐Ÿ˜ผ

Have a look at mine๐Ÿ˜๐Ÿ‘‹.

GitHub logo 8bithemant / 8bithemant

Github README.md. Consists of Lot of Badges, git, png, and a lot of Love, Live Github Stats. Add this to your profile and help me with contributing to this stuff. Github Profile README.md

Hi there, I'm Hemant! ๐Ÿ‘‹.


Hemant Joshi| Twitter Linkedin Telegram Instagram  Reddit Leetcode  Codechef


GIF


Hi ๐Ÿ™‹โ€โ™‚๏ธ,

I'm 18 years old Self-taught Full-Stack developer from India.

- ๐Ÿฅ€ Learning GraphQl ,NextJs &Typescript .

- ๐Ÿ”ญ SpaceX FanBoi,

- ๐Ÿ›ธ Into High Energy Physics and Astrophysics

- ๐Ÿ’ฌ Connect? Here ๐Ÿ‘‰๐Ÿผ


I am Into , ๐Ÿ™

Machine Learning, Web Development, SEO, Micro Services, System Design, Competetive Programming & Physics and Physics ๐Ÿ˜ผ

Github Stats By Anurag



- Languages and Tools...

html csharpjspythonreactvuechromeclouddatascienceawsnpmgcpbashvscode

- Blogs ๐ŸŒฑ

- Podcast โšก๏ธ


Thank You-๐Ÿ™๐Ÿผ






Collapse
ketanrajpal profile image
Ketan Rajpal

Ketan Rajpal Github Profile Readme

My Github Profile Readme

Collapse
xiaoluoboding profile image
Yunwei Xiao • Edited

Have a look at mine โœจ

I use a fancy fonts style

github.com/xiaoluoboding

Collapse
sanchitbajaj02 profile image
Sanchit Bajaj • Edited

Profile Image
My Github Profile.
If you like my work, do give a โญ

Collapse
danmba profile image
Dan

Is there any way in markdown to do a responsive image (ie. different images for different widths)?

You can use an img tag in GitHub markdown, but it doesn't support srcset.

Collapse
lorddashme profile image
Joshua Clifford Reyes

Great Article!

Just want to share this to add some details for the Github README profile ๐Ÿ˜„

dev.to/lorddashme/the-github-contr...

Thanks!

Collapse
codeperfectplus profile image
Deepak Raj

Here is mine. How's It.
If anyone needs source code, fork it.

Hi ๐Ÿ‘‹, I'm Codeperfectplus

codeperfectplus

Skilled in Data Science, Machine Learning, Deep Learning, As Well As Basic Basic Web Development Knowledge. Strong professional with a Master's Diploma in Data Science.

react css3 django docker html5 typescript postgresql python

codeperfectplus

codeperfectplus codeperfectplus codeperfectplus codeperfectplus






Collapse
codeperfectplus profile image
Deepak Raj
Collapse
annietaylorchen profile image
Annie Taylor Chen

Haha how can I not follow this trend, here is mine. :) Made with animated svg!

annie taylor chen github readme profile

Collapse
hifiaz profile image
fiaz

thanks! because of this article i also create github.com/hifiaz

Collapse
ankit512 profile image
Ankit Kumar

Gave it a shot.

GitHub logo Ankit512 / Ankit512

This is the personal profile readme for...well me!

Hi there, I'm Ankit ๐Ÿ‘‹๐Ÿ‘จโ€๐Ÿ’ป

Linkedin GitHub Ankit Kumar| Twitter Instagram  Reddit HackerRank Medium

Hi, I'm Ankit Kumar, final year CSE undergrad from SRM Institute of Science and Technology, KTR ๐Ÿซ. I'm also an indie game developer ๐ŸŽฎ snekaing my way into Data Science and Analytics ๐Ÿคซ.

Beside's developing stuff, I enjoy watching and playing sports โšฝ, listening to music ๐ŸŽง and eating food ๐Ÿ•. Apart from that, I'm also a pundit when it comes to sports like Football, Basketball and F1 ๐Ÿง.

I'm also a die-hard supporter of Manchester United Football Club โšฝโค.

Uncomfortable thought: Warm Soda ๐Ÿ˜ฃ.

GIF

Talking about Personal Stuffs:

  • ๐ŸŒฑ Game-Dev domain lead at Think-Digital
  • ๐ŸŽฎ Indie Game Developer
  • ๐Ÿ“ˆ Data Analyst
  • ๐Ÿ“Š Data Science and Data Analytics Enthusiast
  • ๐Ÿ‘ฆ Student Ambassador at Foxmula
  • โ„ Github's Arctic Code Vault Contributor batch holder
  • ๐Ÿ’ผ Currently looking for new job opportunities
  • ๐Ÿ’ฌ Ask me about anything, I amโ€ฆ
Collapse
waylonwalker profile image
Waylon Walker

Such a cool feature!!!

I had quite a few good ones submitted, you should add yours as well.

Collapse
gsmahajan profile image
Girish Mahajan

dillinger.io/ give it a shot. Quiet handy tool