From: Patrick Canterino <patrick@patrick-canterino.de>
Date: Fri, 9 Mar 2018 13:13:22 +0000 (+0100)
Subject: Updated README
X-Git-Url: https://git.p6c8.net/dsmonrot.git/commitdiff_plain/6200d7b4d77ecbc52a212e3a93498d748ea23607?ds=sidebyside

Updated README
---

diff --git a/README.md b/README.md
index 428817b..7c6ee29 100644
--- 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
diff --git a/TODO.md b/TODO.md
index 42ac55d..5079e04 100644
--- a/TODO.md
+++ b/TODO.md
@@ -7,5 +7,6 @@
 - [x] Clean up the messages sent to the console or send them to the debug or error streams (e.g. `Write-Debug` or `Write-Error`)
 - [x] Rotate log files
 - [x] Suppress output of some commands
+- [x] Allow multiple backups for a day
 - [ ] Add some comments to the source code
-- [x] Allow multiple backups for a day
\ No newline at end of file
+- [ ] Update README
\ No newline at end of file