Skip to content

Commit 20f096f

Browse files
committed
add bare minimum README.md
1 parent d81f4e5 commit 20f096f

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,27 @@
11
# git-clone-sparse
22

3-
[![Package Version](https://badge.fury.io/js/git-clone-sparse.svg)](https://www.npmjs.com/package/git-clone-sparse)
3+
[![Package Version](https://badge.fury.io/js/@ayan4m1/git-clone-sparse.svg)](https://www.npmjs.com/package/@ayan4m1/git-clone-sparse)
44

55
## features
66

77
- Written in TypeScript
88
- Small footprint
9+
- Saves time when cloning large repos
910

1011
## requirements
1112

1213
- Node 18+
1314

15+
## installation
16+
17+
> npm i -g @ayan4m1/git-clone-sparse
18+
1419
## usage
1520

16-
**TODO**
21+
> git-clone-sparse ./local-dir https://github.com/user/repo ./path1/ ./path2/
22+
23+
OR
24+
25+
> git-clone-sparse -g ./local-dir https://github.com/user/repo "\*\*/\*.safetensors"
26+
27+
Each command creates a directory called `local-dir` in your current working directory and then clones the specified URL. If you use **glob mode**, pass the `-g` flag. If you want to use a list of directories instead, do not use the `-g` flag.

0 commit comments

Comments
 (0)