From d6f2988591408eec0e6c227ea07791927edcc55b Mon Sep 17 00:00:00 2001 From: Florian Pritz Date: Sun, 2 Apr 2017 11:41:27 +0200 Subject: Start documenting the main class Signed-off-by: Florian Pritz --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 3e18b86..e6405fc 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,20 @@ App::BorgRestore - Restore paths from borg backups # DESCRIPTION -App::BorgRestore is ... +App::BorgRestore is a restoration helper for borg. + +It maintains a cache of borg backup contents (path and latest modification +time) and allows to quickly look up backups that contain a path. It further +supports restoring a path from an archive. The archive to be used can also be +automatically determined based on the age of the path. + +The cache has to be updated regularly, ideally after creating or removing +backups. + +**borg-restore.pl** is a wrapper around this class that allows for simple CLI +usage. + +This package uses [Log::Any](https://metacpan.org/pod/Log::Any) for logging. # LICENSE -- cgit v1.2.3-24-g4f1b