Support optional syncing of README.md to allow controlling sdk_version for Spaces

[xiaoyao9184]

Hi 👋,

Thanks for this great GitHub Action! I’d like to request a new optional feature:

Feature Request: Optional README.md Syncing
In recent updates, Gradio has introduced support for MCP (Model Context Protocol). In order to use MCP in Hugging Face Spaces, I upgraded the gradio version in my code, but forgot to manually update the sdk_version in the Space’s README.md. This caused unexpected behavior when deploying the updated space.

https://github.com/nateraw/huggingface-sync-action/blob/e130545cd60ff1f7652aa5beec968bf54dff214d/sync_with_spaces.py#L38C38-L38C47

Currently, README.md is excluded from syncing. However, allowing optional syncing of README.md (e.g. via a sync_readme: true option) would allow fully version-controlling Hugging Face Space configurations within the Git repo and avoid issues like mine.

[nateraw]

Hey there, thank you for taking the time to check this out and explain your feature well.

I left out the README because on GitHub you usually want the readme to be intelligible, but unfortunately the Hugging Face Spaces style readmes are quite ugly. Wrestled with this one a bit but wasn't sure which route to go.

Maybe this?

1. As you suggest, some flag to turn on syncing of readme
2. Add another flag like readme_path that defaults to README.md that you can optionally change to a different path to prevent github landing page for your repo from being ugly

lmk what you think. Also would greatly appreciate a PR if you're up for it 😄