Join the Conversation!
Subscribing gives you access to the comments so you can share your ideas, ask questions, and connect with others.
Customize your Profile README
Loading...
0 Comments
"Please login to view comments"
Upgrade your account
"Please login to view comments"
Subscribing gives you access to the comments so you can share your ideas, ask questions, and connect with others.
Before we dive into "how to customize your GitHub profile README," please understand that you don't need to include all the elements mentioned below. Select the ones that best represent you and your work.
š Ā Iām currently working asĀ Sr. Software Engineer @JSMastery
š±Ā Iām currently learningĀ Solidity - Blockchain
šÆ Iām looking to collaborate on open source/commercial projects
š¤Ā Iām looking for help with digital marketing to drive traffic to my blog
š¬Ā Ask me aboutĀ Web Development
š¢ I'm currently living in London, UK š¬š§.
š I use daily: JavaScript, Python, Git, Bash, VS Code
š» I work using: React, MaterialUI, ChakraUI, Node.js, MongoDB, Vercel, GitHub
ā”ļø Fun fact: I'm a huge fan of Bat Man, I love to eat and travel
šµ Tea Enthusiast: Can't start my day without a warm cup of tea.
š I'm a passionate developer on an exciting coding journey.
š± I love exploring new technologies and coding challenges.
š” Building innovative solutions that make a positive impact.
š Currently, I'm focusing on personal projects and honing my skills to create something remarkable.
š¬Feel free to reach out and discuss anything related to coding and development.
š« You can contact me at your_email@example.com
ā” Fun fact: When I'm not coding, you can find me exploring new hiking trails and playing the guitar! šø
For example, to add a short list of skills to a GitHub profile, you would include the following line of Markdown in your README.
/
Include links to your Twitter, Medium, LinkedIn, or other relevant social media profiles.
First Method
/
## Connect with me
[](https://jsmastery.pro)
[](https://jsmastery.pro)
[](https://jsmastery.pro)
[](https://jsmastery.pro)Second Method
/
<a href="https://www.linkedin.com/in/javascriptmastery">
<img
src="https://raw.githubusercontent.com/username/reponame/branch/foldername/icon.svg"
alt="icon | LinkedIn"
align="left"
width="21px"
/>
</a>Third Method
You can use the iconic repo, to use the icons:
/
[<img align="left" alt="JSM" width="22px" src="https://raw.githubusercontent.com/iconic/open-iconic/master/svg/globe.svg" />][website]
[<img align="left" alt="JSM | Twitter" width="22px" src="https://cdn.jsdelivr.net/npm/simple-icons@v3/icons/twitter.svg" />][twitter]
[<img align="left" alt="JSM | LinkedIn" width="22px" src="https://cdn.jsdelivr.net/npm/simple-icons@v3/icons/linkedin.svg" />][linkedin]Or you can use this cdn:
/
[<img align="left" alt="JSM" width="22px" src="https://cdn.jsdelivr.net/npm/simple-icons@3.0.1/icons/linkedin.svg" />][website]
There are many options for badge creation. The Beautify GitHub Profile list contains a Badges section with 26 options.
/
/
<img alt=āReactā src=āhttps://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB"/>/
Use GitHub statistics to showcase the importance and popularity of your repositories.
You can showcase your GitHub profile statistics using the following code snippet:
/
Replace "adrianhajdin" with your GitHub username to display your profile statistics.
If you want to change the theme of the stats, go to this link and choose the theme you like and replace the tokyonight text in the URL with the name of the theme you want.
/
/
Grab visitors' attention by adding GIFs or images at the top of your profile README.
Visual content helps to engage users quickly, making them more likely to explore your profile further.
If you have a blog, you can showcase your latest posts on your GitHub profile. This can help drive traffic to your blog and increase your readership.
And recruiters can get a better idea of your writing style and technical knowledge.
Including a start- and end comment in the README file, so the list can be placed in-between
/
<!-- BLOG-POST-LIST:START -->
<!-- BLOG-POST-LIST:END -->Adding an action to be performed automatically
In your profile repository, create a folder calledĀ .github,Ā and inside that, another folder calledĀ workflows.
Here, we will create a file calledĀ blog-post-workflow.ymlĀ and paste in the following code.
/
name: Latest blog post workflow
on:
# Run workflow automatically
schedule:
# This will make it run every hour
- cron: "0 0 * * *"
# Run workflow manually (without waiting for the cron to be called), through the Github Actions Workflow page directly
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:
# Replace this URL with your rss feed URL/s
feed_list: "https://medium.com/feed/@developingfaizaan"All of these will help you create a great GitHub profile ReadMe, making your profile stand out and attract attention.
