README.rdoc in cloud-backup-0.0.1 vs README.rdoc in cloud-backup-0.0.2
- old
+ new
@@ -1,10 +1,49 @@
= cloud-backup
-Description goes here.
+Backup to multiple cloud storage engines easily!
+Backup to cloud services with ease and easily plug or unplug the storage
+service that you might prefer.
+
+If it doesn't exist you can contribute, or you can create
+a driver class and use it locally!
+
+== Example usage:
+
+ require 'rubygems'
+ require 'cloud-backup'
+
+ # The idea is that you can plug and unplug drivers with ease, each one
+ # supporting different storage services like s3, cloudfiles, google
+ # storage, etc.
+
+ # NOTE: Files must exist!
+ # ==============================================================================
+ files = ['/tmp/kz0', '/tmp/kz1', '/tmp/kz2']
+
+
+ # Use the RackCloud-driver to store data in rackspace!
+ # ==============================================================================
+ mysql = RackCloudBackupDriver.new { :id => 'xx', :key => 'xx', :bucket => 'xx' }
+
+ # Use the Log-driver to log or display what is being executed.
+ # ==============================================================================
+ log = LogBackupDriver.new STDOUT
+
+
+ # Stack Drivers and execute!
+ # ==============================================================================
+ stack = CloudBackup::DriverStack.new
+ stack.add_driver mysql
+ stack.add_driver log
+ stack.add_files files
+
+ stack.perform_backup!
+
+
== Note on Patches/Pull Requests
-
+
* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Commit, do not mess with rakefile, version, or history.