DEV Community

Cover image for How to add an awesome README to your GitHub Profile
Satvik Chachra
Satvik Chachra

Posted on • Updated on

How to add an awesome README to your GitHub Profile

Hi Reader! ✌
In this post, we are going to learn how to add an awesome to a GitHub Profile. This is how it will look like:

I was exploring the new GitHub feature that lets you add a README to your GitHub Profile when I came across this tweet.
This was the true inspiration behind my

Key Steps:

  1. Make a repository
  2. Build a Website and Screen Record
  3. Convert the Video into a GIF
  4. Host it and add it to the

Here's a link to my GitHub repository for your reference.

GitHub logo satvikchachra / profile-readme

Website made for adding a README to GitHub Profile. Built for Desktop view only.

Set up the GitHub Repository

  • Create a repository with your GitHub username


  • Create a

So now that you have set it up, let's come to the interesting part: Designing your

Build a Website and Screen Record

Now let's jump into the Code!
Let's divide the code into 2 main sections.

Section 1: Particles JS

GitHub Link:

When you look at the background there are some white particles floating and forming polygons.
We will use particiles.js to bring that effect into life.

  • Important tip: Remember to run the index.html file on a Live Server otherwise, you won't observe the particle effect.

Step 1: Include the CDN Link for particles.js

<script src=""></script>

Step 2: Specify the div and it's id where you want the particle effect. (in the index.html file).

<div id="particles-js">

Apply a style to the div.

#particles-js {
    background-color: #a0d0f8;
    height: 860px;
    width: 100%;

Step 3: To run the particles.js on load

(Here assets is a directory that contains patricles.json file.)

/* particlesJS.load(@dom-id, @path-json, @callback (optional)); */
particlesJS.load('particles-js', 'assets/particles.json', function() {
  console.log('callback - particles.js config loaded');

Step 4: Create a particles.json file.

You can tweak the values in the particles.json file. Experiment and have fun there!

Check this out:
A great tutorial in case you get stuck somewhere.

Section 2: Typewriter JS
GitHub Link:

Step 1: Include the CDN Link for typewriter.js

<script src=""></script>

Step 2: Specify the div and it's id where you want the typewriter effect. (in the index.html file).

<div id="typewriter"></div>

Apply a style to the div.

#typewriter {
    position: absolute;
    font-size: 60px;
    font-family: 'B612', sans-serif;
    font-weight: 700;
    width: 800px;
    margin: 350px 250px;

Step 3: Create an object of Typewriter class pre-defined through the CDN link.

// To run this effect in loop set 'loop' to true
const instance = new Typewriter('#typewriter', {
    loop: true

Step 4: Use different methods to achieve the desired result

typeString(): Types a string. Takes a string as a parameter.

pauseFor(): Pauses the effect. Takes the number of milliseconds as a parameter.

deleteAll(): Deletes the entire string. Takes speed as an optional parameter.

deleteChars(): Deletes characters of a string. Takes the number of characters as a parameter.

start(): Starts the typewriter effect.

instance.typeString("Hello World!")
    .typeString('I am Your-Name.')
    .typeString('an aspiring<br>Your-Goal.')
    .typeString('currently learning<br>Your-Skill.')
    .typeString('Check out my work at<br>')
  • Important tip: Remember to nest the divs because you want the typewriter effect in front and particle effect in the background.
<div id="particles-js">
        <div id="typewriter"></div>

Add styling to elements on the page to get the desired output.

Now you can record the screen using any application.
I personally use OBS.
Check out this resourceful tutorial on how to screen record using OBS.

Convert the Video into a GIF

Converting the video to a GIF gets tricky because of two reasons:

  1. Large Size: GitHub doesn't allow to upload large size files.
  2. Loss in quality: There's a significant loss in quality when the video is converted to GIF format.

I personally used this application for conversion.

Host the GIF.

There are many platforms you can host your GIF on.
I personally used GIPHY. It's really simple.
Just sign up and hit upload.

Here's what Upload section looks like:

Alt Text

Here's the uploaded GIF:

Alt Text

Copy the selected GIF link.

Alt Text

Finally, add the link to your

Alt Text

Push the changes! 🚀

And now you have a beautiful Congratulations! 🥳🎉

This was my first tutorial. Your feedback would be much appreciated. Thank you 😊

Top comments (7)

juanfrank77 profile image
Juan F Gonzalez

Great post!
Very detailed and concise at the same time. I, for one, wouldn't use that cuz I feel several people would be doing the same and don't want to lump myself into the Readme Gif category hahaha 😄

satvikchachra profile image
Satvik Chachra

I am glad you liked the tutorial! I am excited and looking forward to a lot of creative Readme(s). I think you might like Dynamic Readme(s). Check them out.
I am sure you would put something amazing on your GitHub profile. All the best 😊

alterdieg0 profile image
Diego Valenzuela • Edited

<div id="paricles-js">

here is a typo, should be particles-js.
Nice tutorial

satvikchachra profile image
Satvik Chachra

Thank you. I just fixed it 😊 I am glad you liked the tutorial 😊

matteobruni profile image
Matteo Bruni

Have you ever tried tsParticles?

satvikchachra profile image
Satvik Chachra

I will try it out 😊 btw Great work 👏