What is a GitHub Profile README?
A GitHub Profile README is a markdown file that you can add to your GitHub profile to give visitors a quick overview of your skills, projects, and contact information. It's a great way to make a good first impression and showcase your work
Create a repo of your github name (github id) and also create a
README.md
file.
Checkout my youtube video to learn markdown
What to Include in Your GitHub Profile README
There are a few things that you should include in your GitHub Profile README:
- Your name and a brief introduction.
- List your skills and experience, highlighting your most relevant ones.
- Showcase your projects, including links to their repositories.
- Include your contact information so that people can reach out to you.
- Tell people what you want them to do, whether it's subscribing to your newsletter or following you on social media.
Example
# Hi there π
I'm Vuelancer, a full-stack web developer with a passion for building beautiful and user-friendly websites. I have experience with Vue.js, React, and Node.js.
**Here are some of my projects:**
* [My Portfolio](https://myportfolio.com)
* [My Blog](https://myblog.com)
**Get in touch:**
* [Email](mailto:me@myemail.com)
* [Twitter](https://twitter.com/mytwitter)
* [LinkedIn](https://www.linkedin.com/in/mylinkedin)
Additional Tips
- Use a clear and concise writing style.
- Use Markdown to format your README.
- Add images and links to make your README more visually appealing.
- Keep your README up-to-date as your skills and projects change.
My Current Github Profile
Github link - vuelancer
I'm Dhivakar Selvakumar
====================================
Full Stack Developer
--------------------
I've been learning coding for 6.5+ years and have great exposure in javascript full-stack frameworks.
* π» Check my leetcode profile to understand more about me [linkedin](https://www.linkedin.com/in/selvakumardhivakar/) & [leetcode](https://leetcode.com/selvakumardhivakar)
* πΒ I'm based in India
* βοΈΒ You can contact me at [selvakumardhivakar@gmail.com](mailto:selvakumardhivakar@gmail.com)
* πΒ I'm currently working on [Infosys](http://www.infosys.com/) as Specialist Programmer
* π§ Β I'm currently exploring Nextjs
* π€Β I'm open to collaborating on projects that can be interesting now & then
* β‘Β In love with Javascript & C++
### Coding platform
* [Leetcode](https://leetcode.com/selvakumardhivakar)
* [GeeksforGeeks](https://auth.geeksforgeeks.org/user/dhivakars1)
### Skills
<p align="left">
<a href="https://docs.microsoft.com/en-us/cpp/?view=msvc-170" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/skills/cplusplus-colored.svg" width="36" height="36" alt="C++" /></a>
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/skills/javascript-colored.svg" width="36" height="36" alt="JavaScript" /></a>
<a href="https://www.python.org/" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/skills/python-colored.svg" width="36" height="36" alt="Python" /></a>
<a href="https://vuejs.org/" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/skills/vuejs-colored.svg" width="36" height="36" alt="Vue" /></a>
<a href="https://reactjs.org/" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/skills/react-colored.svg" width="36" height="36" alt="React" /></a>
<a href="https://svelte.dev/" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/skills/svelte-colored.svg" width="36" height="36" alt="Svelte" /></a>
<a href="https://nodejs.org/en/" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/skills/nodejs-colored.svg" width="36" height="36" alt="NodeJS" /></a>
<a href="https://www.mongodb.com/" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/skills/mongodb-colored.svg" width="36" height="36" alt="MongoDB" /></a>
<a href="https://firebase.google.com/" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/skills/firebase-colored.svg" width="36" height="36" alt="Firebase" /></a>
<a href="https://flutter.dev/" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/skills/flutter-colored.svg" width="36" height="36" alt="Flutter" /></a>
<a href="https://www.figma.com/" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/skills/figma-colored.svg" width="36" height="36" alt="Figma" /></a>
</p>
### Socials
<p align="left"> <a href="https://www.codesandbox.com/selvakumardhivakar" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/socials/codesandbox.svg" width="32" height="32" /></a> <a href="https://www.dev.to/vuelancer" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/socials/devdotto.svg" width="32" height="32" /></a> <a href="https://www.github.com/selvakumardhivakar" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/socials/github.svg" width="32" height="32" /></a> <a href="https://Vuelancer.hashnode.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/socials/hashnode.svg" width="32" height="32" /></a> <a href="https://www.linkedin.com/in/selvakumardhivakar" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/socials/linkedin.svg" width="32" height="32" /></a> <a href="https://www.twitter.com/vuelancer" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/socials/twitter.svg" width="32" height="32" /></a> <a href="https://www.youtube.com/c/UC0hmXRqXYVO0mocVt5D3GkQ" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/danielcranney/readme-generator/main/public/icons/socials/youtube.svg" width="32" height="32" /></a></p>
Top comments (8)
Making a good Readme is really important.
I never got any feedback on mine, i don't know if it ok or needs improvement.
Can you please help me check it out and critic it?
github.com/Abdulmumin1
Thanks.
Your profile is soo great!
I'm humbled π, I need critics so I can improve!
A few posts ago we learned about readMeMaker: v0.1 which uses A.I. to help you consistently create a
README.md
file from your files.Its a simple readme.
ππππ
Creating a website if someone provides their github profile link, It will be great to implement.
Great!