diff --git a/README.md b/README.md new file mode 100644 index 0000000..62f1420 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ + + +# git-annex + +## Purpose + +This is a basic dockerized version of [git-annex](https://git-annex.branchable.com/) + +## Usage + +Simple, just create an alias: + +``` +git config --global alias.annexd 'docker run --rm -ti -v $PWD:/git --user $(id -u):$(id -g) registry.gitlab.com/schtobia/git-annex' +```