From ffc18194fa644972e0219c46213cf0f983bb6852 Mon Sep 17 00:00:00 2001
From: Sam Lanning <sam@samlanning.com>
Date: Sat, 10 May 2025 00:39:48 +0100
Subject: [PATCH] Add a section on known limitations

---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index 1be7cfe..cd7ffda 100644
--- a/README.md
+++ b/README.md
@@ -286,6 +286,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