GitHub Profile README | Create an Amazing Profile Readme | Setup + Templates

JavaScript Mastery · Intermediate ·🌐 Frontend Engineering ·5y ago

Key Takeaways

Create a GitHub profile README using Markdown and templates, and optimize your profile to showcase your stats, social media links, and projects, with tools like GitHub, Netlify, and React.

Full Transcript

hello everyone and welcome to another javascript mastery video in this video i'm going to show you how to make your github profile stand out from the crowd there are many ways in which you can show your profile or work to the world especially if you're a programmer modern ways include hosting your own website displaying your complete portfolio this has brought freedom to utilize all the unique ideas and without any restrictions to the number of pages style or the font in the resume people now develop creative interactive online resumes which creates a good impact on potential employers recently github added the ability to add a readme file on your profile above the pinned repositories and it can take as much space above the fold of the web page as you'd like a profile level readme feels like a natural revolution of the project level convention most of the github users are already familiar with this feature allows you to show more data on the profile bio and the fact that it supports markdown means that you have infinite possibilities you can play around with emojis images gifs and pretty much anything now the next logical question would be well how can you create your own profile readme without any further ado let's do that right now once you're logged in on your github you can navigate to the top right of your screen click this plus icon and then click new repository you have to create a new repository with the same name including the letter casing as your github username for me it says that i cannot create a new one because i already have one and that's completely okay but for you it's going to say something like this you found a secret this is a special repository that you can use to add a readme md to your github profile make sure it's set to public and initialize it with a readme to get started so after you do that make sure to scroll down click add a readme and then click create repository after that you'll be navigated to a page that looks like this just a typical github repository now you can edit that readme file which was created for you let's see how it looks in action for you something is already going to be typed in here but let's type hello world if we now save this we should be able to see it above our profile as you can see it's here but that's not all that cool how are you going to create better looking and more interactive profile readmes for you i prepared a page where you can find hundreds and hundreds of different profile readme templates let's open a few for example there are the code styled ones and let's open the first five ones just so we can see how they look as you can see this one looks great in here you can type your name you can say where you're currently working at you can add all your social media and then we have a little block of code there which has some additional information let's keep going forwards and see a few more this is just two blocks of code in here a lot of things are happening again you can see having the ability to add markdown adds us so much more functionality we can specify when we are doing our commits and what did we spend time on during this week we have some more and some more again the ones that i like the most are going to be the short and sweet ones you don't want to over complicate your profile readme so let's open 5 from the short and sweet directory as you can see we have a few headings a few bullet points and then github stats and finally links to all social media let's say that i like this one i'm going to close all the rest and now how do we actually add it well you go to raw here then you copy all of that and finally you can go to your profile and then click this little icon right here after you do that you can paste everything and now you can change all the things that you want let's just change the name to show your github stats the only thing you have to do is change the username here so i'm going to do that and then we have connect with me and links to all social medias so if we now click commit changes at the bottom of the page let's see how it looks like as you can see that's great we can see my stats you can see the links to social medias the headings the bullet points and the best thing is that it actually shows on your bio on your profile above your pinned repositories that's amazing in here you can provide information on which stack are you working on or maybe even specify that you're looking for a job that's it now you know how to add your profile readme but that's not it on having your github profile stand out you can see how i have this pinned repositories here i also try to contribute as much as i can and i made sure that all my projects have nicely written readmes with live links descriptions images live sites and all the important details so allow me to show you how you can do the same things on the pages of your projects first of all let's talk about the readme if you click this little pen icon right here it's going to show us the markdown to use a heading in markdown you can use a hash symbol to create a smaller heading you can use two or three hashes in here i'm also using a link everything that's inside of the square brackets is going to be the thing that's going to be written inside of a link and this inside of the parentheses is going to be the actual link where you're going to be taken once you click on this text in this case it's a link pointing to the site i deployed on netlify you can see that right there no one has to actually run the code install the dependencies they can just click a link and they are there moving forward this is the actual image i just took a screenshot of the software and then just uploaded it to the internet and then you can use the link if you just google online image upload you should find a lot of services that allow you to simply host your images online and then they give you a link and you can use that link right there and finally this is the introduction with all the descriptions and what's nice to have is the setup so in here i tell the users how they can run and install the dependencies if they want to run this project locally furthermore in here this is the about part a really important part as well github added a lot of functionalities to this part recently in here for this project i simply said this is a code repository for the corresponding youtube video in this tutorial we're going to build and deploy a real-time chat application cover topics react node express and socket io you can also add tags here to edit it you can click this little icon and that leads you to this in here you can add that website topics and you can even specify what they want to include in here that's it with just a little bit of work you can make your pages stand out here's a little update more than 10 months have passed since i started creating the complete path to javascript mastery this is a long course that covers absolutely everything you need to know about javascript starting with easy things such as variables logic and control flow functions tricky concepts even some projects and then moving on to more complex topics such as arrays in detail objects in detail and to more complex topics such as value versus reference prototypes asynchronous javascript and so on if you're interested in learning javascript in depth more than you learned it in any course you've taken so far then you might be interested in this the course is not yet out but you can sign up for the mailing list the link is going to be down in the description you can enter your email just to be sure you can know when the course is released you're also going to get a big discount just for being on the mailing list when the course is released if you'd like me to make this video into a series where i'm going to help you to optimize your github profile or just in general give you some tips on getting hired just let me know and i'm going to turn this into a series for that leave a like comment and subscribe see you in the next one [Music] you

Original Description

GitHub added the ability to add a Readme file on your profile, A profile README feels like the natural evolution of the project-level convention most of the GitHub users are already familiar with. This feature allows you to show more data on the profile bio and the fact that it supports markdown, means that you have infinite possibilities; you can play around with emojis, images, gifs, letters. 📚 Materials/References: Profile Readme Templates: https://github.com/kautukkundan/Awesome-Profile-README-templates Mailing-list: https://thejavascriptmastery.com Explore our Pro Content: ⚠ If the links aren’t working for you, please try using a VPN (e.g., in Nigeria) ⭐ Join JS Mastery Pro: https://jsmastery.com?utm_source=youtube&utm_campaign=video-title 💎 Become a Top 1% Next.js Developer: https://jsmastery.com/course/the-ultimate-next-js-15-course 💎 Master Next.js Testing: https://jsmastery.com/course/the-complete-next-js-testing-course 📗 GSAP Pro Course (includes GTAVI Website): https://jsmastery.com/course/gsap-animations-course 📕 Three.js 3D Pro Course: https://jsmastery.com/course/vanilla-three-js-course 📙 JavaScript Pro Course: https://jsmastery.com/course/complete-path-to-javascript-mastery 🚀 Launch Your SaaS Pro Course: https://jsmastery.com/course/build-launch-your-saas-in-under-7-days 👉 React Native Pro Course Waitlist: https://jsmastery.com/waitlist/react-native-course 👉 Backend Pro Course Waitlist: https://jsmastery.com/waitlist/ultimate-backend-course 👉 React.js Pro Course Waitlist: https://jsmastery.com/waitlist/react-course 👉 Tailwind Pro Course Waitlist: https://jsmastery.com/waitlist/tailwindcss-course 👉 AI Development Pro Course Waitlist: https://jsmastery.com/waitlist/ai-course Rate us on TrustPilot: https://jsm.dev/trustpilot https://discord.com/invite/n6EdbFJ https://twitter.com/jsmasterypro https://instagram.com/javascriptmastery https://linkedin.com/company/javascriptmastery Business Inquiries: contact@jsmastery.pro
Watch on YouTube ↗ (saves to browser)
Sign in to unlock AI tutor explanation · ⚡30

Playlist

Uploads from JavaScript Mastery · JavaScript Mastery · 29 of 60

1 Learn Async/Await in This Real World Project
Learn Async/Await in This Real World Project
JavaScript Mastery
2 JavaScript Exercise | Learn JavaScript with Exercism | #0 Setup
JavaScript Exercise | Learn JavaScript with Exercism | #0 Setup
JavaScript Mastery
3 JavaScript ES6 for Beginners
JavaScript ES6 for Beginners
JavaScript Mastery
4 ES7 and ES8 New Features
ES7 and ES8 New Features
JavaScript Mastery
5 Learn JSON in a Real World React App
Learn JSON in a Real World React App
JavaScript Mastery
6 How to Create PDFs With Node JS and React
How to Create PDFs With Node JS and React
JavaScript Mastery
7 Must Have Visual Studio Code Extensions
Must Have Visual Studio Code Extensions
JavaScript Mastery
8 Top 10 JavaScript Array Methods
Top 10 JavaScript Array Methods
JavaScript Mastery
9 JavaScript Map and Set Explained
JavaScript Map and Set Explained
JavaScript Mastery
10 Git Commands Tutorial for Beginners
Git Commands Tutorial for Beginners
JavaScript Mastery
11 Build and Deploy a YouTube Clone Application Using React
Build and Deploy a YouTube Clone Application Using React
JavaScript Mastery
12 React Hooks - Most Used Features
React Hooks - Most Used Features
JavaScript Mastery
13 JavaScript Best Practices and Coding Conventions - Write Clean Code
JavaScript Best Practices and Coding Conventions - Write Clean Code
JavaScript Mastery
14 Build and Deploy a Realtime Chat Application - Socket.io, Node.js, and React.js
Build and Deploy a Realtime Chat Application - Socket.io, Node.js, and React.js
JavaScript Mastery
15 How to Create and Deploy a Portfolio Site in less than 30 Minutes
How to Create and Deploy a Portfolio Site in less than 30 Minutes
JavaScript Mastery
16 SEO for Developers | 2020 SEO Tutorial
SEO for Developers | 2020 SEO Tutorial
JavaScript Mastery
17 Web Development Roadmap 2020 [Learning Path] - Start Coding at Home!
Web Development Roadmap 2020 [Learning Path] - Start Coding at Home!
JavaScript Mastery
18 Random Quote Generator - React Fetch API Data | Build and Deploy a Real Advice App Project
Random Quote Generator - React Fetch API Data | Build and Deploy a Real Advice App Project
JavaScript Mastery
19 Build a COVID-19 Tracker Application - React JS Project (Hooks, Material UI, Charts js)
Build a COVID-19 Tracker Application - React JS Project (Hooks, Material UI, Charts js)
JavaScript Mastery
20 JavaScript ES2020 - The Most Requested Feature Explained in 10 Minutes
JavaScript ES2020 - The Most Requested Feature Explained in 10 Minutes
JavaScript Mastery
21 Modern React Event Handling Using Hooks
Modern React Event Handling Using Hooks
JavaScript Mastery
22 Deno JS - Intro +  Real Life Example
Deno JS - Intro + Real Life Example
JavaScript Mastery
23 Build and Deploy a React PWA - Why Progressive Web Apps are the Future of the Web
Build and Deploy a React PWA - Why Progressive Web Apps are the Future of the Web
JavaScript Mastery
24 Build a REST API with Node JS and Express | CRUD API Tutorial
Build a REST API with Node JS and Express | CRUD API Tutorial
JavaScript Mastery
25 Build and Deploy an ARTIFICIAL INTELLIGENCE React App | Alan AI, JavaScript
Build and Deploy an ARTIFICIAL INTELLIGENCE React App | Alan AI, JavaScript
JavaScript Mastery
26 Master Async JavaScript using Async/Await | Quokka JS
Master Async JavaScript using Async/Await | Quokka JS
JavaScript Mastery
27 Spaced Repetition in Programming | mem.dev
Spaced Repetition in Programming | mem.dev
JavaScript Mastery
28 Stop Copy & Pasting Code | mem.dev
Stop Copy & Pasting Code | mem.dev
JavaScript Mastery
GitHub Profile README | Create an Amazing Profile Readme | Setup + Templates
GitHub Profile README | Create an Amazing Profile Readme | Setup + Templates
JavaScript Mastery
30 NEW GitHub CLI 1.0 is here! | GitHub CLI Tutorial - Demo & Commands
NEW GitHub CLI 1.0 is here! | GitHub CLI Tutorial - Demo & Commands
JavaScript Mastery
31 React Custom Hooks | Learn Custom Hooks & Build a Project
React Custom Hooks | Learn Custom Hooks & Build a Project
JavaScript Mastery
32 Learn how to deploy an NPM Package
Learn how to deploy an NPM Package
JavaScript Mastery
33 JavaScript Algorithms for Beginners
JavaScript Algorithms for Beginners
JavaScript Mastery
34 Level UP your GitHub Game - Get Hired Quickly
Level UP your GitHub Game - Get Hired Quickly
JavaScript Mastery
35 The Best Way to Host & Deploy a React Application
The Best Way to Host & Deploy a React Application
JavaScript Mastery
36 Full Stack MERN Project - Build and Deploy an App | React + Redux, Node, Express, MongoDB [Part 1/2]
Full Stack MERN Project - Build and Deploy an App | React + Redux, Node, Express, MongoDB [Part 1/2]
JavaScript Mastery
37 Full Stack MERN Project - Build and Deploy an App | React + Redux, Node, Express, MongoDB [Part 2/2]
Full Stack MERN Project - Build and Deploy an App | React + Redux, Node, Express, MongoDB [Part 2/2]
JavaScript Mastery
38 ECommerce Web Shop - Build & Deploy an Amazing App | React.js, Commerce.js, Stripe
ECommerce Web Shop - Build & Deploy an Amazing App | React.js, Commerce.js, Stripe
JavaScript Mastery
39 JavaScript Crash Course 2021 - Master JavaScript in One Video!
JavaScript Crash Course 2021 - Master JavaScript in One Video!
JavaScript Mastery
40 MERN Auth - Login with Email (JWT) + Google OAuth Authentication | React, Node, Express, MongoDB
MERN Auth - Login with Email (JWT) + Google OAuth Authentication | React, Node, Express, MongoDB
JavaScript Mastery
41 Chat Application using React JS - Build and Deploy a Chat App in 1 Hour (Microsoft Teams)
Chat Application using React JS - Build and Deploy a Chat App in 1 Hour (Microsoft Teams)
JavaScript Mastery
42 MUST USE Websites & Tools for Web Developers
MUST USE Websites & Tools for Web Developers
JavaScript Mastery
43 Learn Material UI in One Hour - React Material UI Project Tutorial [2022]
Learn Material UI in One Hour - React Material UI Project Tutorial [2022]
JavaScript Mastery
44 Shopify ECommerce Store with React & Next JS | BuilderIO
Shopify ECommerce Store with React & Next JS | BuilderIO
JavaScript Mastery
45 React Video Chat App | WebRTC Video Chat Zoom Clone | Tabnine
React Video Chat App | WebRTC Video Chat Zoom Clone | Tabnine
JavaScript Mastery
46 TypeScript Crash Course 2021
TypeScript Crash Course 2021
JavaScript Mastery
47 Build and Deploy a Premium Next JS React Website | Landing Page, Business Website, Portfolio
Build and Deploy a Premium Next JS React Website | Landing Page, Business Website, Portfolio
JavaScript Mastery
48 Full Stack MERN Project - Pagination & Search | React + Redux, Node, Express, MongoDB
Full Stack MERN Project - Pagination & Search | React + Redux, Node, Express, MongoDB
JavaScript Mastery
49 Build a BETTER Facebook Messenger Chat Application | React JS, Firebase, Chat Engine
Build a BETTER Facebook Messenger Chat Application | React JS, Firebase, Chat Engine
JavaScript Mastery
50 Build and Deploy THE PERFECT Portfolio Website | Create a Portfolio from Scratch
Build and Deploy THE PERFECT Portfolio Website | Create a Portfolio from Scratch
JavaScript Mastery
51 Full Stack MERN Project - Implement MERN Comments | React + Redux, Node, Express, MongoDB
Full Stack MERN Project - Implement MERN Comments | React + Redux, Node, Express, MongoDB
JavaScript Mastery
52 Turn an API into a Startup?! Build & Sell an API with JavaScript
Turn an API into a Startup?! Build & Sell an API with JavaScript
JavaScript Mastery
53 Exclusive First Look at GitHub Copilot - All you need to know
Exclusive First Look at GitHub Copilot - All you need to know
JavaScript Mastery
54 Build and Deploy a Google Maps Travel Companion Application | React.js
Build and Deploy a Google Maps Travel Companion Application | React.js
JavaScript Mastery
55 Build and Deploy a Full Stack Realtime Chat Messaging App with Authentication & SMS Notifications
Build and Deploy a Full Stack Realtime Chat Messaging App with Authentication & SMS Notifications
JavaScript Mastery
56 Build and Deploy a React Cryptocurrency App and Master Redux Toolkit in One Video
Build and Deploy a React Cryptocurrency App and Master Redux Toolkit in One Video
JavaScript Mastery
57 Build and Deploy a Group Video Chat Application with Messaging, Polls & More
Build and Deploy a Group Video Chat Application with Messaging, Polls & More
JavaScript Mastery
58 Build and Deploy Google Search 2.0 with React & Tailwind CSS (simple!)
Build and Deploy Google Search 2.0 with React & Tailwind CSS (simple!)
JavaScript Mastery
59 Top 10 Web Development Chrome Extensions You Simply Need to Try!
Top 10 Web Development Chrome Extensions You Simply Need to Try!
JavaScript Mastery
60 Build and Deploy THE BEST Modern Blog App with React | GraphQL, NextJS, Tailwind CSS
Build and Deploy THE BEST Modern Blog App with React | GraphQL, NextJS, Tailwind CSS
JavaScript Mastery

Create a GitHub profile README to showcase your skills and experience, and optimize your profile to get hired, with tools like GitHub, Netlify, and React. This video teaches you how to create a profile README, use Markdown, and host images online.

Key Takeaways
  1. Create a new repository with the same name as your GitHub username
  2. Initialize the repository with a README file
  3. Add a README file to the repository
  4. Edit the README file
  5. Copy the contents of a profile README template
  6. Use Markdown to format your README
  7. Include links, images, and descriptions
  8. Host images online using a link to a live site or online image upload service
💡 Using a GitHub profile README can help you showcase your skills and experience, and get hired, by providing a clear and concise overview of your projects and achievements.

Related AI Lessons

Up next
The masks we wear | Zora Krstić | TEDxLuxembourgCity
TEDx Talks
Watch →