Skip to content

Commit d1d2bc4

Browse files
authored
Add a section on known limitations (#42)
1 parent 295d847 commit d1d2bc4

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -287,6 +287,16 @@ await commitFilesFromBuffers({
287287
});
288288
```
289289

290+
## Known Limitations
291+
292+
Due to using the GitHub API to make changes to repository contents,
293+
there are some things it's not possible to commit,
294+
and where using the Git CLI is still required.
295+
296+
- Executable files
297+
- Symbolic Links
298+
- Submodule changes
299+
290300
## Other Tools / Alternatives
291301

292302
- [planetscale/ghcommit](https://github.com/planetscale/ghcommit) - Go library for committing to GitHub using graphql

0 commit comments

Comments
 (0)