{"meta":{"title":"Managing your profile README","intro":"You can add a README to your GitHub profile to tell other people about yourself.","product":"Account and profile","breadcrumbs":[{"href":"/en/account-and-profile","title":"Account and profile"},{"href":"/en/account-and-profile/how-tos","title":"How-tos"},{"href":"/en/account-and-profile/how-tos/profile-customization","title":"Profile customization"},{"href":"/en/account-and-profile/how-tos/profile-customization/managing-your-profile-readme","title":"Your profile README"}],"documentType":"article"},"body":"# Managing your profile README\n\nYou can add a README to your GitHub profile to tell other people about yourself.\n\n## Prerequisites\n\nGitHub will display your profile README on your profile page if all of the following are true.\n\n* You've created a repository with a name that matches your GitHub username.\n* The repository is public.\n* The repository contains a file named README.md in its root.\n* The README.md file contains any content.\n\n> \\[!NOTE]\n> If you created a public repository with the same name as your username before July 2020, GitHub won't automatically show the repository's README on your profile. You can manually share the repository's README to your profile by going to the repository on GitHub and clicking **Share to profile**.\n\n## Adding a profile README\n\n1. In the upper-right corner of any page, select <svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon octicon-plus\" aria-label=\"Create something new\" role=\"img\"><path d=\"M7.75 2a.75.75 0 0 1 .75.75V7h4.25a.75.75 0 0 1 0 1.5H8.5v4.25a.75.75 0 0 1-1.5 0V8.5H2.75a.75.75 0 0 1 0-1.5H7V2.75A.75.75 0 0 1 7.75 2Z\"></path></svg>, then click **New repository**.\n\n   ![Screenshot of a GitHub dropdown menu showing options to create new items. The menu item \"New repository\" is outlined in dark orange.](/assets/images/help/repository/repo-create-global-nav-update.png)\n2. Under \"Repository name\", type a repository name that matches your GitHub username. For example, if your username is \"octocat\", the repository name must be \"octocat.\"\n3. Optionally, in the \"Description\" field, type a description of your repository. For example, \"My personal repository.\"\n4. Select **Public**.\n5. Toggle **Add README** to **On**.\n6. Click **Create repository**.\n7. Above the right sidebar, click **Edit README**.\n\nThe generated README file is pre-populated with a template to give you some inspiration for your profile README.\n\nFor a summary of all the available emojis and their codes, see [Emoji cheat sheet](https://www.webfx.com/tools/emoji-cheat-sheet/).\n\n## Removing a profile README\n\nThe profile README will be removed from your GitHub profile if any of the following apply:\n\n* The README file is removed or made empty.\n* The repository is made private.\n* The repository name no longer matches your username due to a change in either or both names.\n\nThe method you choose depends upon your needs, but if you're unsure, we recommend making your repository private. For steps on how to make your repository private, see [Setting repository visibility](/en/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility#changing-a-repositorys-visibility).\n\n## Next steps\n\n* For reference information, see [Profile reference](/en/account-and-profile/reference/profile-reference)."}