diff options
| -rw-r--r-- | README.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..911a516 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# git-mirror + +**git-mirror** is a command-line program to keep local git mirrors up to date with their origin. + +## Configuration + +### Example configuration file +```toml +default_path = "/srv/git" + +[[projects]] +url = "https://github.com/Bond-009/git-mirror.git" + +[[projects]] +url = "https://git.zx2c4.com/cgit" +description = "A hyperfast web frontend for git repositories written in C." +``` + +### Example crontab entry +Execute git-mirror every 15 with the given config. +`*/15 * * * * git-mirror -c /srv/git/config.toml` |