add README

This commit is contained in:
yequari 2023-08-17 10:55:17 -07:00
parent 33cb51928e
commit 7386b12f27
1 changed files with 13 additions and 0 deletions

13
README.md Normal file
View File

@ -0,0 +1,13 @@
# Site Auto Updater
A shell script that polls git repositories for updates then copies the files to a specified location
```
Usage: ./site-update.sh [-b BRANCH|d SRCDIR|f FILE|h|p] OUTDIR
Options
b BRANCH git branch to update, defaults to the current branch in SRCDIR
d SRCDIR directory containing git repository to update, defaults to current working directory
f FILE update a batch of repositories, as defined in FILE
h print this help message
p publish files only, do not update
```