Skip to content

Commit 93bd9dc

Browse files
committed
Update docs
1 parent 73b2211 commit 93bd9dc

File tree

1 file changed

+23
-5
lines changed

1 file changed

+23
-5
lines changed

README.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,25 +21,43 @@ go install github.com/dsxack/gitfs/cmd/gitfs@latest
2121

2222
### Usage
2323

24-
Mount with local repository clone or
25-
remote repository url (in this case repository will be cloned into temporary directory)
24+
Mount
25+
```sh
26+
gitfs mount <repository url> <mountpoint>
27+
```
2628

29+
Mounting local repository
2730
```sh
28-
gitfs mount <local repository url> <mountpoint>
31+
gitfs mount /home/dsxack/work/project /mnt/project
2932
```
3033

31-
Mount in daemon mode
34+
Mounting remote repository (repository will be cloned into memory)
35+
```sh
36+
gitfs mount https://github.com/dsxack/go /mnt/go
37+
```
3238

39+
Mount in daemon mode
3340
```sh
3441
gitfs mount -d <repository> <mountpoint>
3542
```
3643

3744
Umount previously mounted in daemon mode filesystem
38-
3945
```sh
4046
gitfs umount <mountpoint>
4147
```
4248

49+
Mount with verbose logging for debugging reasons
50+
```sh
51+
# Info
52+
gitfs mount https://github.com/dsxack/go /mnt/go -v
53+
54+
# Debug
55+
gitfs mount https://github.com/dsxack/go /mnt/go -vv
56+
57+
# Trace
58+
gitfs mount https://github.com/dsxack/go /mnt/go -vvv
59+
```
60+
4361
### License
4462

4563
[MIT](LICENSE)

0 commit comments

Comments
 (0)