From 8fa8c0dc6644e48d9e0ffc70d0db579a734af549 Mon Sep 17 00:00:00 2001 From: Adam Dobrawy Date: Thu, 1 Apr 2021 00:22:26 +0200 Subject: [PATCH] Add section about profile README --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 280bb62..ca59f29 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,7 @@ A collection of cool hidden and not so hidden features of Git and GitHub. This c - [GitHub Talks](#github-talks) - [SSH keys](#ssh-keys) - [Profile Image](#profile-image) + - [Profile README](#profile-readme) - [Repository Templates](#repository-templates) - [Git](#git) - [Remove All Deleted Files from the Working Tree](#remove-all-deleted-files-from-the-working-tree) @@ -682,6 +683,14 @@ https://github.com/{user}.png e.g. [https://github.com/tiimgreen.png](https://github.com/tiimgreen.png) +### Profile README + +You can create a own profile README by create file `README.md` in a public repository with a name that matches your GitHub username. GitHub shows your profile README at the top of your profile page. + +For example see [abhisheknaiidu/awesome-github-profile-readme](https://github.com/abhisheknaiidu/awesome-github-profile-readme). + +[*Read more about Profile README*](https://docs.github.com/en/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme) + ### Repository Templates You can enable templating on your repository which allows anyone to copy the directory structure and files, allowing them to instantly use the files (e.g. for a tutorial or if writing boilerplate code). This can be enabled in the settings of your repository.