README.md in imap-backup-1.4.2 vs README.md in imap-backup-2.0.0.rc1
- old
+ new
@@ -14,10 +14,16 @@
[Source Code]: https://github.com/joeyates/imap-backup "Source code at GitHub"
[API documentation]: http://rubydoc.info/gems/imap-backup/frames "RDoc API Documentation at Rubydoc.info"
[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"
+## Version 2
+
+With versions above 2.x, this gems stores IMAP metadata in a
+backwardly-incompatible way. When upgrading, all old backups will be gradually
+deleted to allow for the new file format to be introduced.
+
# Installation
```shell
$ gem install 'imap-backup'
```
@@ -156,11 +162,18 @@
...
],
"debug": true
}
```
+# Restore
+All missing messages are pushed to the IMAP server.
+Existing messages are left unchanged.
+
+This functionality requires that the IMAP server supports the UIDPLUS
+extension to IMAP4.
+
# Other Usage
List IMAP folders:
```shell
@@ -188,16 +201,36 @@
# Testing
## Integration Tests
-Integration tests are run against a Docker image
+Integration tests (feature specs) are run against a Docker image
(antespi/docker-imap-devel:latest).
+In one shell, run the Docker image:
+
+```
+docker run \
+ --env MAIL_ADDRESS=address@example.org \
+ --env MAIL_PASS=pass \
+ --env MAILNAME=example.org \
+ --publish 8993:993 \
+ antespi/docker-imap-devel:latest
+```
+
Currently, the integration tests with Docker are excluded from the CI run.
-The image has a pre-existing user:
-`address@example.org` with password `pass`
+To run **just** the Docker-based tests:
+
+```
+rspec -t docker
+```
+
+To run **all** specs, including the integration tests, do the following:
+
+```
+rspec -O .rspec-all
+```
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)