]> git.p6c8.net - dsmonrot.git/commitdiff
Updated README
authorPatrick Canterino <patrick@patrick-canterino.de>
Fri, 9 Mar 2018 13:13:22 +0000 (14:13 +0100)
committerPatrick Canterino <patrick@patrick-canterino.de>
Fri, 9 Mar 2018 13:13:22 +0000 (14:13 +0100)
README.md
TODO.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
diff --git a/TODO.md b/TODO.md
index 42ac55d110da44482f1cf65d319987b10536003e..5079e042b0754f1d207fb6be77e0e238331802f9 100644 (file)
--- 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

patrick-canterino.de