loading...

Getting started with your personal GitHub README

iainfreestone profile image Iain Freestone ใƒป1 min read

GitHub has recently added a feature to add personal profile README files. This is a page that will appear when someone visits your profile on Github allowing visitors to learn a bit more about you.

Getting Started

First up if you have not already created your personal Github README, Monica Powell has a great article on setting one up.

How To Create A GitHub Profile README

Alt Text


If you prefer video, Harry Wolff has a quick video on getting started with your profile README.


Inspiration and Ideas

Need some inspiration, checkout Awesome-Profile-README.

GitHub logo kautukkundan / Awesome-Profile-README-templates

A collection of awesome readme templates to display on your profile

banner

The aim of this repository is to collect awesome READMEs that developers around the world are using on their own profiles to act as an inspiration for others.

Feel free to add your own or someone else's profile README if you find it super awesome!

Don't forget to leave a โญ if you found this useful.




GitHub logo elangosundar / awesome-README-templates

A collection of awesome readme templates to display on your github profile.

Awesome README Templates

A collection of awesome readme templates to display on your github profile.

Stars Badge Forks Badge Pull Requests Badge Issues Badge GitHub contributors License Badge

Loved the project? Please visit our Website


This repo aims to collect the all `awesome beautiful READMEs profile` and make your Profile look good & Inspire other's

If you are intersted, will create a PR for to add your README profile here.

If you like this Repo, Please click the โญ

List of awesome README Profile categories mentioned below

Contents

Website

Link : https://awesome-github-readme-profile.netlify.app

Awesome README Templates

Github README PROFILE CATEGORY

List out Awesome README Profile Tools


Tools

Dynamically generated GitHub stats on your readmes!

GitHub logo anuraghazra / github-readme-stats

โšก Dynamically generated stats for your github readmes

GitHub Readme Stats

GitHub Readme Stats

Get dynamically generated GitHub stats on your readmes!

Tests Passing Issues GitHub pull requests

View Demo ยท Report Bug ยท Request Feature

็ฎ€ไฝ“ไธญๆ–‡ ยท Espaรฑol ยท Deutsch ยท ๆ—ฅๆœฌ่ชž

Loved the project? Please consider donating to help it improve

Features

GitHub Stats Card

Copy paste this into your markdown content, and that's it. Simple!

Change the ?username= value to your GitHub's username.

[![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)

Note: Ranks are calculated based on user's stats, see src/calculateRank.js

Hiding individual stats

To hide any specific stats, you can pass a query parameter ?hide= with comma separated values.

Options: &hide=stars,commits,prs,issues,contribs

![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=contribs,prs)

Adding private contributions count to total commits count

You can add the count of all your private contributions to the total commits count by using the query parameter ?count_private=true.

Note: If you are deploying this projectโ€ฆ

Colored Badges for GitHub profiles

GitHub logo MikeCodesDotNET / ColoredBadges

Some badges I created for my GitHub profile readme.

Colored Badges for GitHub profiles

I've put together some badges I for my GitHub profile readme as shown below and thought they might be useful to others.

my github bio page!


The Badges

All badges are available as both SVG & PNG. I've also included the original Figma file I used to create these should you want to change the text.


How to add a readme on your profile

It's super simple!

Create a new repo using your GitHub username as the repo name. Voilร ! ๐ŸŽ‰๐ŸŽ‰๐ŸŽ‰๐ŸŽ‰


Tips for using the Icons

I'm sure you're already a pro with creating GitHub markdown documents, but I thought I'd give you a quick tip anyways.

Always try to use the SVG icons over the png. SVGs are scalable and look fabulous no matter what size device or DPI settings the viewer is using.

You can add an SVG image with a link usingโ€ฆ

WakaTime Weekly Metrics on your Profile Readme

GitHub logo athul / waka-readme

Wakatime Weekly Metrics on your Profile Readme.

Dev Metrics in Readme Build Status

Project Preview


WakaTime Weekly Metrics on your Profile Readme:

Prep Work

  1. You need to update the markdown file(.md) with 2 comments. You can refer here for updating it.
  2. You'll need a WakaTime API Key. You can get that from your WakaTime Account Settings
    • You can refer here, if you're new to WakaTime
  3. Optional You'll need a GitHub API Token with repo scope from here if you're running the action not in your Profile Repository
    • You can use this example to work it out
  4. You need to save the WakaTime API Key (and the GitHub API Token, if you need it) in the repository secrets. You can find that in the Settings of your Repository.Be sure to save those as the following
    • WakaTime-api-key as WAKATIME_API_KEY = <your wakatime API Key>and
    • The GitHub Access Token as GH_TOKEN=<your github access token>
  5. You can follow either of the Two Examplesโ€ฆ




Build a self-updating profile README for GitHub with help from Simon Willison.

Self updating profile README

Alt Text


Sign up to our free weekly newsletter and stay in the loop with the latest and greatest web development projects on GitHub at www.trendingprojects.com

If you enjoyed this article you can follow me on Twitter where I regularly post bite size tips relating to HTML, CSS and JavaScript.

Posted on by:

iainfreestone profile

Iain Freestone

@iainfreestone

A Web developer from Hampshire in the south of England.

Discussion

markdown guide
 

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 latest add-ons like visitors count, github stats, etc using minimal UI.

Github Profile Readme Generator

Github Profile Readme Generator

github-profile-readme-generator licence

github-profile-readme-generator gif

Tired of editing Github Profile README with new features?

This tool provides an easy way to create github profile readme with latest addons like visitors count, github stats etc.

๐Ÿš€ Try it out: Live demo

๐Ÿง Features

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

Click on Generate README to get your README in markdown. You can preview the README too.

You can add latest addons like visitors count, shields, dev icons, github stats etc to your README in just one click.

Designed with ๐Ÿ’ซ by Rahul




 

Thanks for that article! I don't known that is possibility to create personal readme on GitHub, will do it! :)