diff --git a/README.md b/README.md index b1b54fc..c0d1387 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,14 @@ +A 'simple' collection of bash scripts that syncs CodiMD files with a certain metadata block to Gitlab + + +You need to put the following block somewhere in you CodiMD file. + +```markdown +:::spointer Gitlab sync +- sync-to: path/in/the/drive +::: +``` + ## Setup