From dcef1d3e1b83ff5c271d98b72843f7ff6c7b6a7e Mon Sep 17 00:00:00 2001 From: holly sparkles Date: Sun, 21 Jan 2024 09:01:12 +0100 Subject: [PATCH] docs: update readme --- README.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 39718dd..3780583 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,33 @@ A utility that automatically updates mirrored git repositories. Written in Rust. -## Usage (hopefully) +## Usage ```shell -git-fetcher --refresh-time=10m /srv/git +git-mirror-sync --refresh-time=10m /srv/git + +git-mirror-sync --refresh-time=10m --max-recursion-depth=2 /srv/git ``` -`/srv/git` is the path to **[bare][]** git repositories. +`/srv/git` is the path to [bare git repositories][]. + +[bare git repositories]: https://git-scm.com/book/en/v2/Git-on-the-Server-Getting-Git-on-a-Server -[bare]: https://git-scm.com/book/en/v2/Git-on-the-Server-Getting-Git-on-a-Server ## Why? -Why not? I wrote this in bash and got bored. So now I write it in Rust :) +Why not? I wrote this in bash and got bored. Now I've made one in Rust :) + +## Project Status + +This is a **work-in-progress**. In its current state, it works, and it works well. + +**To-Do:** + +- migrate to using [git2][] instead of the git binary +- documentation +- unit tests? + +[git2]: https://github.com/rust-lang/git2-rs ## License -- libgit2 1.7.2