README.md in imap-backup-0.0.2 vs README.md in imap-backup-0.0.3

- old
+ new

@@ -16,47 +16,57 @@ gem install 'imap-backup' # Basic Usage -* Create ~/.imap-backup +* Create ~/.imap-backup directory and configuration file +```shell +$ cd +$ mkdir .imap-backup +$ chmod 0700 .imap-backup +$ cd .imap-backup +$ touch config.json +$ chmod 0600 config.json +``` + +``` +{ + "accounts": + [ { - accounts: - [ - { - username: "my.user@gmail.com", - password: "secret", - local_path: "/path/to/backup/root", - folders: - [ - {name: "[Gmail]/All Mail"}, - {name: "my_folder"} - ] - } - ] + "username": "my.user@gmail.com", + "password": "secret", + "local_path": "/path/to/backup/root", + "folders": + [ + {"name": "[Gmail]/All Mail"}, + {"name": "my_folder"} + ] } + ] +} +``` * Run imap-backup -# Usage +# Other Usage -Check connection: +List IMAP folders: - imap-backup --check + imap-backup folders -List IMAP folders: +Get statistics of emails to download per folder: - imap-backup --list + imap-backup status # Design Goals * Secure - use a local file protected by permissions -* Restartable - calculate start point based on alreadt downloaded messages -* Standards compliant - save emails in a standard format -* Standalone - does not rely on an email client or MTA +* Restartable - calculate start point based on already downloaded messages +* Standalone - do not rely on an email client or MTA # Similar Software * https://github.com/thefloweringash/gmail-imap-backup * https://github.com/mleonhard/imapbackup