README.md in iphoto_backup-0.0.1 vs README.md in iphoto_backup-1.0.0
- old
+ new
@@ -1,27 +1,55 @@
-# IphotoBackup
+[](https://travis-ci.org/wireframe/iphoto_backup)
-TODO: Write a gem description
+# iphoto_backup
+> Every photo deserves to live in a folder on the filesystem and not
+> to be locked up in some cryptic and proprietary iPhoto metadata XML file.
+
+iphoto_backup is a tool to simplify backups and archiving of your iPhoto images.
+
[Originally implemented as a Python script](https://github.com/wireframe/dotfiles/blob/628b982d9fc4e7b4cc9e6ca806cae81b541f9bbd/home/bin/iphoto_export.py)
## Installation
-Add this line to your application's Gemfile:
+```bash
+$ gem install iphoto_backup
+```
- gem 'iphoto_backup'
+## Usage
-And then execute:
+```bash
+$ iphoto_backup
- $ bundle
+Processing Roll: Wedding Pics...
+ copying /iphoto/file.png to /my/custom/backup.png
+```
-Or install it yourself as:
+## Options
- $ gem install iphoto_backup
+#### --filter [REGEX]
-## Usage
+*aliased to -e*
-TODO: Write usage instructions here
+Restrict exporting to only albums that match the given regular expression. Albums that do not match the regex will be printed in the log output as well.
+
+example:
+```bash
+$ iphoto_backup -e Summer
+
+
+Processing Roll: Summer Pics...
+ copying /iphoto/file.png to /my/custom/backup.png
+
+Winter Pics does not match the filter: /Summer/
+```
+
+#### --output [/path/to/directory]
+
+*aliased to -o*
+*default to ~/Google Drive/Dropbox*
+
+Customize the path for archiving photos.
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)