Skip to content

Commit 1f22091

Browse files
committed
Add more examples about installing and using it
1 parent d3383f7 commit 1f22091

File tree

1 file changed

+36
-4
lines changed

1 file changed

+36
-4
lines changed

README.md

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,14 @@ gitfs [![Build Status](https://drone.presslabs.net/api/badges/PressLabs/gitfs/st
33

44
# Welcome to GitFS
55

6-
76
gitfs is a [FUSE](http://fuse.sourceforge.net/) file system that fully
87
integrates with git. You can mount a remote repository's branch locally, and any
98
subsequent changes made to the files will be automatically committed to the
109
remote.
1110

12-
gitfs was developed by the awesome engineering team at [Presslabs](https://www.presslabs.com/),
11+
gitfs was developed by the awesome engineering team at [Presslabs](https://www.presslabs.com/),
1312
a Managed WordPress Hosting provider.
1413

15-
For more open-source projects, check [Presslabs Code](https://www.presslabs.org/).
16-
1714
## What's its purpose?
1815

1916
gitfs was designed to bring the full powers of git to everyone, no matter how
@@ -26,6 +23,41 @@ gitfs is useful in places where you want to keep track of all your files, but at
2623
the same time you don't have the possibility of organizing everything into
2724
commits yourself. A FUSE filesystem for git repositories, with local cache.
2825

26+
## Installing
27+
28+
We provide packages for the major Ubuntu releases and MacOS, but you can find community packages for most of popular Linux
29+
distributions. If you want to build packages for a distribution, or you already did, please contact us and we'll list it here.
30+
31+
### Ubuntu 18.04+
32+
33+
```bash
34+
sudo add-apt-repository ppa:presslabs/gitfs
35+
sudo apt-get update
36+
sudo apt-get install gitfs
37+
```
38+
39+
### MacOS
40+
```bash
41+
brew install gitfs
42+
```
43+
44+
## Usage
45+
46+
You can mount a remote or local repository easly, just by providing the repository to clone and a directory used to mount.
47+
48+
```bash
49+
gitfs http://your.com/repository.git /mount/directory
50+
```
51+
52+
The entire filesystem can be tweaked when mounting it, using a set of options.
53+
54+
```bash
55+
gitfs git@github.com:user/repo.git /mypath -o
56+
repo_path=/tmp/path,branch=dev,log=-,debug=true,foreground=true,fetch_timeout=0.1,merge_timeout=0.1...
57+
```
58+
59+
For an entire list of options, you can check the [arguments page](https://www.presslabs.com/code/gitfs/gitfs-arguments/).
60+
2961
## Features
3062
* Automatically commits changes: create, delete, update files and their metadata
3163
* Browse through working index and commit history

0 commit comments

Comments
 (0)