diff --git a/README.md b/README.md index 51dc287..81d2725 100644 --- a/README.md +++ b/README.md @@ -287,6 +287,16 @@ await commitFilesFromBuffers({ }); ``` +## Known Limitations + +Due to using the GitHub API to make changes to repository contents, +there are some things it's not possible to commit, +and where using the Git CLI is still required. + +- Executable files +- Symbolic Links +- Submodule changes + ## Other Tools / Alternatives - [planetscale/ghcommit](https://github.com/planetscale/ghcommit) - Go library for committing to GitHub using graphql