DEV Community

Cover image for How to Add a README to a GitHub Organization's Profile?
Ludal πŸš€
Ludal πŸš€

Posted on • Updated on • Originally published at iamludal.fr

How to Add a README to a GitHub Organization's Profile?

You may already know how to add a README to your GitHub profile (if you don't, have a look at this article), but did you know you can also add one to an organization's profile? πŸ€”

To do so, just head over to the GitHub organization you want to customize, and create a new repository named .github.

GitHub special repository

As you can see, GitHub already tells you that you discovered a special repository (once again πŸ˜›).

⚠️ Make sure to set the repository's visibility to public.

From there, the only thing you have to do is creating a profile/README.md file within this repository, that will show up in the organization homepage.

⚠️ Make sure to create the README.md within the profile directory.

Editing the README.md file

And here's the final result, on the organization's GitHub homepage:

Final Result


Other Articles by Me


References

Top comments (0)