diff --git a/README.md b/README.md new file mode 100644 index 0000000..cb73e13 --- /dev/null +++ b/README.md @@ -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 +```