Skip to content

Commit c339b1d

Browse files
committed
doc: update README.md
1 parent 288bc51 commit c339b1d

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

+18
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,21 @@
22

33
**git-cache-rs** is a git helper that allows caching clones in a central folder
44
so consequtive clones become faster.
5+
6+
It works by first cloning into a cache folder (`~/.gitcache` by default), then
7+
cloning locally out from there. The next time the same repository is cloned, it
8+
will be cloned from the cache.
9+
10+
## Installation
11+
12+
cargo install git-cache
13+
14+
## How to use
15+
16+
Just use `git cache clone <clone options>` instead of `git clone <clone
17+
options>`. Add `-U` if you'd like the cached version to update from the
18+
original repository before cloning (not needed for the first clone).
19+
20+
## License
21+
22+
git-cache-rs is licensed under the terms of the Apache License (Version 2.0).

0 commit comments

Comments
 (0)