From e911e1cf456c66dac25664e50884a269e620b8f6 Mon Sep 17 00:00:00 2001 From: netbenix Date: Fri, 31 Dec 2021 17:39:54 +0100 Subject: [PATCH] docs(README): Added config examples --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/README.md b/README.md index 9bacc73..df43a79 100644 --- a/README.md +++ b/README.md @@ -69,3 +69,38 @@ Trello board: [Click me!](https://trello.com/b/6zWLE6Jm) | fileshareName | string | The name of the Azure File Share | | storageAccountName | string | Name of your storage account | | storageAccountKey | string | Key for the storage account | + + +## Config Examples + +### config.json (Linux) +``` +{ + "foldersToBackup": [ + { + "backupName": "my-backup", + "folderPath": "/path/to/folder/to/backup", + "remoteStorageType": "remote-type", + "remoteTargetPath": "path/to", + "createLocalBackup": true, + "localTargetPath": "/path/for/local/backup" + } + ] +} +``` + +### config.json (Windows) +``` +{ + "foldersToBackup": [ + { + "backupName": "my-backup", + "folderPath": "D:\\Path\\To\\Folder\\To\\Backup", + "remoteStorageType": "remote-type", + "remoteTargetPath": "path/to", + "createLocalBackup": true, + "localTargetPath": "E:\\Path\\For\\Local Backup" + } + ] +} +``` \ No newline at end of file