README.md in imap-backup-4.0.0.rc1 vs README.md in imap-backup-4.0.0.rc2

- old
+ new

@@ -18,24 +18,28 @@ # GMail To use imap-backup with GMail, you will need to enable 'App passwords' on your account. -## GMail OAuth2 +# Installation -GMail OAuth2 authentication is supported, but as GMail's policy requires -users to set up an application specific to their account, the feature -is disabled by default. +```shell +$ gem install 'imap-backup' +``` -You will need to set the environment variable IMAP_BACKUP_ENABLE_GMAIL_OAUTH2. +# Commands -To set it up, [follow the HOWTO](docs/setting-up-gmail-with-oauth2.md). +For a full list, run -# Installation +``` +$ imap-backup help +``` +For more information about a command, run + ```shell -$ gem install 'imap-backup' +$ imap-backup help COMMAND ``` # Setup In order to do backups, you need to add accounts via a menu-driven command @@ -145,9 +149,19 @@ # Result Each folder is saved to an mbox file. Alongside each mbox is a file with extension '.imap', which lists the source IMAP UIDs to allow a full restore. + +# Local commands + +There a various commands for viewing local backup status. + +To view the list, use + +```shell +$ imap_backup help local +``` # Troubleshooting If you have problems: