README.md in imap-backup-0.0.4 vs README.md in imap-backup-0.0.5
- old
+ new
@@ -12,25 +12,22 @@
[Rubygem]: http://rubygems.org/gems/imap-backup "Ruby gem at rubygems.org"
[Continuous Integration]: http://travis-ci.org/joeyates/imap-backup "Build status by Travis-CI"
# Installation
- gem install 'imap-backup'
+ $ gem install 'imap-backup'
-# Basic Usage
+# Setup
-* Create ~/.imap-backup directory and configuration file
+Run:
-```shell
-$ cd
-$ mkdir .imap-backup
-$ chmod 0700 .imap-backup
-$ cd .imap-backup
-$ touch config.json
-$ chmod 0600 config.json
-```
+ $ imap-backup setup
+The setup system is a menu-driven command line application.
+
+It creates ~/.imap-backup directory and configuration file. E.g.:
+
```
{
"accounts":
[
{
@@ -45,12 +42,25 @@
}
]
}
```
-* Run
+# Security
- imap-backup
+Note that email usernames and passwords are held in plain text
+in the configuration file.
+
+The directory ~/.imap-backup, the configuration file and all backup
+directories have their access permissions set to only allow access
+by your user.
+
+# Run Backup
+
+Manually, from the command line:
+
+ $ imap-backup
+
+Altertatively, add it to your crontab.
# Other Usage
List IMAP folders: