Skip to content

Commit 7289525

Browse files
committed
readme: add note about intended use cases
1 parent 39126aa commit 7289525

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ branch protection.
1616
It is possible to sign commits with GPG, however managing GPG keys can be cumbersome,
1717
especially when maintainers leave a project. Using the API eliminates the need for key management.
1818

19+
:warning: This is meant for use in CI environments and with small commits. For example, a CI workflow
20+
that formats code and commits the changes. This is not meant to be used for large commits
21+
and should not be used in place of `git` for day-to-day development.
22+
1923
## Install
2024

2125
1. go install: `go install github.com/pantheon-systems/ghcommit@latest`

0 commit comments

Comments
 (0)