README.md in imap-backup-8.0.1 vs README.md in imap-backup-8.0.2

- old
+ new

@@ -5,23 +5,25 @@ # imap-backup Backup, restore and migrate email accounts. -The backups can then be restored, used to migrate to another service, -inspected or exported. +# Modes - * [Source Code] - * [Code Documentation] - * [Rubygem] - * [CI Status] +There are two types of backups: -[Source Code]: https://github.com/joeyates/imap-backup "Source code at GitHub" -[Code Documentation]: https://rubydoc.info/gems/imap-backup/frames "Code Documentation at Rubydoc.info" -[Rubygem]: https://rubygems.org/gems/imap-backup "Ruby gem at rubygems.org" -[CI Status]: https://github.com/joeyates/imap-backup/actions/workflows/main.yml +* Keep all (the default) - progressively saves a local copy of all emails, +* Mirror - adds and deletes emails from the local copy to keep it up to date with the account. +# What You Can Do with a Backup + +* Migrate - use the local copy to populate emails on another account. This is a once-only action that deletes any existing emails on the destination account. +* Mirror - make a destination account match the local copy. This action can be repeated. +* Restore - push the local copy back to the original account. + +See below for a [full list of commands](#Commands). + # Installation ## Homebrew (macOS) If you have [Homebrew](https://brew.sh/), do this: @@ -65,10 +67,13 @@ imap-backup ``` Alternatively, add it to your crontab. +Backups can also be inspected, for example via [local show](docs/commands/local-show.md) +and exported via [utils export-to-thunderbird](docs/commands/utils-export-to-thunderbird.md). + # Commands * [backup](docs/commands/backup.md) * [local accounts](docs/commands/local-accounts.md) * [local folders](docs/commands/local-folders.md) @@ -97,14 +102,24 @@ # Troubleshooting If you have problems: 1. ensure that you have the latest release, -2. turn on debugging output via the `imap-backup setup` main menu. +2. run `imap-backup` with the `-v` or `--verbose` parameter. # Development See the [Development documentation](./docs/development.md) for notes on development and testing. See [the CHANGELOG](./CHANGELOG.md) to a list of changes that have been made in each release. + +* [Source Code] +* [Code Documentation] +* [Rubygem] +* [CI Status] + +[Source Code]: https://github.com/joeyates/imap-backup "Source code at GitHub" +[Code Documentation]: https://rubydoc.info/gems/imap-backup/frames "Code Documentation at Rubydoc.info" +[Rubygem]: https://rubygems.org/gems/imap-backup "Ruby gem at rubygems.org" +[CI Status]: https://github.com/joeyates/imap-backup/actions/workflows/main.yml