Update 'README.md'

2020-02-17 13:00:57 +00:00
parent 89618d562a
commit e671bd76dd
1 changed files with 13 additions and 1 deletions
--- a/README.md
+++ b/README.md
@@ -1,2 +1,14 @@
-# Docker.Containers.GitSparseClone
+# Docker.Containers.GitSparseClone [![Build Status](https://ci.spamasaurus.com/api/badges/djpbessems/Docker.Containers.GitSparseClone/status.svg)](https://ci.spamasaurus.com/djpbessems/Docker.Containers.GitSparseClone)
+Useful as a Kubernetes-sidecar container that downloads files from a git-repository to a Kubernetes-volumeMount, which other containers can then also mount and use.  

+### Usage:
+```  
+docker run -it \
+    -e SPARSE_CHECKOUT=<filter> \
+    -e REMOTE_REPO=<url> \
+    -e REMOTE_BRANCH=<branch> \
+    -e TARGET_DIR=<path> \
+# Optional
+    -e FLATTENFOLDER=true \
+-d djpbessems/git-sidecar
+```