aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMirek Kratochvil <exa.exa@gmail.com>2026-09-10 16:52:55 +0200
committerMirek Kratochvil <exa.exa@gmail.com>2026-09-10 16:52:55 +0200
commita4826233e7eb9c6bf55994172acf284605f47fa7 (patch)
treecfdaa7b8a88253fb0e5fc6fe2edeb64f804acef9
parentb03b268d6600b37dd921794cd69a7de16bf7828b (diff)
downloadgit-auto-acp-a4826233e7eb9c6bf55994172acf284605f47fa7.tar.gz
git-auto-acp-a4826233e7eb9c6bf55994172acf284605f47fa7.tar.bz2
okay
-rw-r--r--README.md27
1 files changed, 26 insertions, 1 deletions
diff --git a/README.md b/README.md
index b1b25ec..a28b7ba 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,28 @@
# git-auto-acp: automatically add, commit and push changed files
-This does as the header says.
+This does exactly as the header says.
+
+Help is as follows:
+
+```
+git-auto-acp -- automatically add-commit-push files
+
+Usage: git-auto-acp [-d|--commit-delay ARG]
+ [(-L|--local) | (-D|--push-delay ARG)]
+ ((-a|--add PATH) | (-A|--add-all PATH)) [-m|--message MSG]
+
+Available options:
+ -d,--commit-delay ARG debuounce delay for adding and commiting new changes
+ (default: 5.0)
+ -L,--local only work locally, do not push
+ -D,--push-delay ARG push changes upstream with this debuounce delay
+ (default: 60.0)
+ -a,--add PATH paths to auto-add
+ -A,--add-all PATH like `--add' but auto-adds file removals
+ -m,--message MSG commit message for auto-commits
+ (default: "update to filesystem state")
+ -h,--help Show this help text
+ --version Show version information
+
+This program is free software; see LICENSE file for details.
+```