summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index febfc0b..adac73b 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,15 @@ App::BorgRestore - Restore paths from borg backups
use App::BorgRestore;
+ my $app = App::BorgRestore->new();
+
+ # Update the cache (call after creating/removing backups)
+ $app->update_cache();
+
+ # Restore a path from a backup that is at least 5 days old. Optionally
+ # restore it to a different directory than the original.
+ $app->restore_simple($path, "5days", $optional_destination_directory);
+
# DESCRIPTION
App::BorgRestore is a restoration helper for borg.