git-mirror-sync.git

author	holly sparkles <sparkles@holly.sh>	2024-01-21 8:01:12.0 +00:00:00
committer	holly sparkles <sparkles@holly.sh>	2024-01-21 8:02:12.0 +00:00:00
commit	dcef1d3e1b83ff5c271d98b72843f7ff6c7b6a7e [patch]
tree	eb7fa408f8e4a83b9b05aff1d101baac214b3b6d
parent	30bfeae4d25f946e5e1e54242ea706ef7f0a88c4
download	dcef1d3e1b83ff5c271d98b72843f7ff6c7b6a7e.tar.gz

docs: update readme

Diff

 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