Updated README

[dsmonrot.git] / README.md

diff --git a/README.md b/README.md
index 428817b54feaf470ce16ae2927850104910d6f0c..7c6ee290dc685de8294c710890c01ddfe552daaa 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,15 @@
-# dsmonrot
-Script for rotating Drive Snapshot backups monthly
+# DSMonRot
+
+DSMonRot is a script for rotating Drive Snapshot backups monthly (DSMonRot stands for **D**rive **S**napshot **Mon**thly **Rot**ate).
+
+It's main purpose is to create a full backup at the beginning and then create differential backups for the rest of the month. Furthermore it rotates the backups after every successful full backup allowing you to keep only a certain amount of monthly backup sets.
+
+## Installation
+
+TODO
+
+## Credits
+
+* DSMonRot: Patrick Canterino, https://www.patrick-canterino.de/
+* Drive Snapshot: Tom Ehlert, http://www.drivesnapshot.de/
+* Logging function (``Write-Log``): Jason Wasser, https://gallery.technet.microsoft.com/scriptcenter/Write-Log-PowerShell-999c32d0 
\ No newline at end of file