Skip to content

Commit

Permalink
πŸ“ Update README with enhanced restore functionality
Browse files Browse the repository at this point in the history
Expand README to detail new restore features

- Add version selection, file preview, and diff display to features list
- Include interactive restore mode in features
- Create new 'Restore Functionality' section with detailed information
- Add example command for interactive restore mode
- Update navigation links with emoji anchors
  • Loading branch information
hyperb1iss committed Sep 6, 2024
1 parent c122eb4 commit 9da2f28
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

*A powerful and flexible remote backup tool for developers and system administrators*

[Features](#features) β€’ [Installation](#installation) β€’ [Usage](#usage) β€’ [Configuration](#configuration) β€’ [Development](#development) β€’ [Contributing](#contributing) β€’ [License](#license)
[Features](#-features) β€’ [Installation](#-installation) β€’ [Usage](#-usage) β€’ [Configuration](#%EF%B8%8F-configuration) β€’ [Development](#%EF%B8%8F-development) β€’ [Contributing](#-contributing) β€’ [License](#-license)

</div>

Expand All @@ -25,6 +25,11 @@
- πŸ” Verbose mode for detailed transfer logs
- πŸ—‚οΈ Multiple source directory support
- πŸ” Automatic latest backup symlink creation
- πŸ•°οΈ Version selection for file restores
- πŸ‘€ File preview before restoration
- πŸ“Š Diff display to compare file versions
- πŸ”„ Interactive restore mode for user-friendly file recovery
- πŸ“œ Comprehensive backup listing with detailed information

## πŸ’» Installation
<a name="installation"></a>
Expand Down Expand Up @@ -79,12 +84,29 @@ aeon --help
aeon sync [OPTIONS]

# Restore a file from a specific backup date
aeon restore [OPTIONS] FILE DATE
aeon restore [OPTIONS] FILE [DATE]

# List all available backups
aeon list-backups [OPTIONS]
```

### Restore Functionality

AeonSync offers powerful restore capabilities:

- πŸ•°οΈ **Version Selection**: Choose from multiple backup versions of a file.
- πŸ‘€ **File Preview**: View file contents before restoring.
- πŸ“Š **Diff Display**: Compare changes between versions.
- πŸ”„ **Interactive Mode**: User-friendly guided restore process.

To use the interactive restore mode:

```bash
aeon restore --interactive
```

This will guide you through selecting a backup date, choosing a file, and specifying the restore location.

For a full list of available commands and options, use:

```bash
Expand Down

0 comments on commit 9da2f28

Please sign in to comment.