README.md in sdbport-0.0.1 vs README.md in sdbport-0.1.0

- old
+ new

@@ -1,25 +1,56 @@ # Sdbport -TODO: Write a gem description +Sdbport exports & imports data from AWS SimpleDB domains. It can be used as a class or stand alone CLI. ## Installation -Add this line to your application's Gemfile: +gem install sdbport - gem 'sdbport' +## Usage -And then execute: +Set your AWS credentials: - $ bundle +``` +export AWS_ACCESS_KEY_ID=key +export AWS_SECRET_ACCESS_KEY=secret +``` -Or install it yourself as: +Export SimpleDB domain: - $ gem install sdbport +``` +sdbport export -a $AWS_ACCESS_KEY_ID -s $AWS_SECRET_ACCESS_KEY -r us-west-1 -n test -o /tmp/test-domain-dump +``` -## Usage +Import into new domain: -TODO: Write usage instructions here +``` +sdbport import -a $AWS_ACCESS_KEY_ID -s $AWS_SECRET_ACCESS_KEY -r us-west-1 -n new-domain -i /tmp/test-domain-dump +``` + +Purge new domain: + +``` +sdbport purge -a $AWS_ACCESS_KEY_ID -s $AWS_SECRET_ACCESS_KEY -r us-west-1 -n new-domain +``` + +To list CLI subcommands: + +``` +sdbport -h +``` + +For details help on specific subcommand: + +``` +sdbport export -h +``` + +## Known Limitations + +* Only performs a single query for exports, which gives it a maxmimum of 1,000 entries. +* Single serialiazed process. +* Only supports importing into empty domain. ## Contributing 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`)