You can share information about how to engage with your organization by creating an organization profile README. GitHub shows your organization profile README in the "Overview" tab of your organization.
You can choose what information to include your organization profile README. Here are some examples of information that may be helpful in your organization's profile README.
- An "About" section that describes your organization
- Guidance for getting help in the organization
You can format text and include emoji, images, and GIFs in your organization profile README by using GitHub Flavored Markdown. For more information, see "Getting started with writing and formatting on GitHub."
- If your organization does not already have a public
.githubrepository, create a public
- In your organization's
.githubrepository, create a
README.mdfile in the
- Commit the changes to the
README.mdfile. The content of the
README.mdwill appear on your organization's profile.