Syncing Github Repo with Huggingface Repo

You could achieve this by placing the README intended for GitHub in .github directory, and the one for Hugging Face Hub in the root:

If you put your README file in your repository’s hidden .github, root, or docs directory, GitHub will recognize and automatically surface your README to repository visitors.
If a repository contains more than one README file, then the file shown is chosen from locations in the following order: the .github directory, then the repository’s root directory, and finally the docs directory.

1 Like