README.md in defog-0.8.0 vs README.md in defog-0.9.0
- old
+ new
@@ -1,13 +1,13 @@
# defog
-[<img
-src="https://secure.travis-ci.org/ronen/defog.png"/>](http://travis-ci.org/ronen/defog) [<img src="https://gemnasium.com/ronen/defog.png" alt="Dependency
-Status" />](https://gemnasium.com/ronen/defog)
+[](http://badge.fury.io/rb/defog)
+[](http://travis-ci.org/ronen/defog)
+[](https://gemnasium.com/ronen/defog)
Defog wraps the [fog](https://rubygems.org/gems/fog) gem (specifically,
-[Fog::Storage](http://fog.io/1.3.1/storage/)), providing access to files
+[Fog::Storage](http://fog.io/storage/)), providing access to files
stored in the cloud via proxy files on the local file system. A proxy file can
be
* Read-only: A local cached copy of a cloud file.
* Write-only: A local file that will be uploaded to the cloud.
* Read-Write: A local file that mirrors a cloud file, propogating changes
@@ -22,14 +22,16 @@
Defog also provides a few simple remote-file management methods to minimize
the need to dig down into the Fog layer; but full access to the underlying fog
objects is available should it be needed.
+Full Rdoc is available at [http://rubydoc.info/gems/defog](Full Rdoc is available at http://rubydoc.info/gems/defog)
+
## Usage Summary
-Full Rdoc is available at http://rubydoc.info/gems/defog
+
### Create proxy connection
Connect to the remote storage by creating a `Defog::Proxy` object, which
proxies files in a specific remote location, e.g.:
@@ -40,11 +42,11 @@
:bucket => "s3-bucket-name")
defog = Defog::Proxy.new(:provider => :Local,
:local_root => "/path/to/directory")
-For complete options, see Defog::Proxy.new RDOC
+For complete options, see [Defog::Proxy.new RDOC](http://rubydoc.info/gems/defog/Defog/Proxy)
### Proxy a file
Open a proxy to a remote file by creating a `Defog::File` object:
@@ -97,10 +99,11 @@
handle = defog.file("key")
handle.exist? # => true if the cloud file exists
handle.delete # deletes the cloud file
handle.size # => size of the cloud file
handle.last_modified # => modification date of the cloud file
+ handle.md5_hash # => MD5 hash digest of the cloud file
In fact, `defog.file("key", mode, options, &block)` is really just shorthand
for
defog.file("key").open(mode, options, &block)
@@ -236,22 +239,23 @@
## Compatibility
Defog is currently known to work on:
-* Ruby: MRI 1.9.2, MRI 1.9.3
+* Ruby: MRI 1.9.2, MRI 1.9.3, MRI 2.0.0
* Fog Storage: :local, :AWS
The above storage providers are what the author uses. Please fork and add
-others! (There's just a very small amount of provider-specific code in one
-file, https://github.com/ronen/defog/blob/master/lib/defog/fog_wrapper.rb,
+others! (There's just a very small amount of provider-specific code in [one
+file](https://github.com/ronen/defog/blob/master/lib/defog/fog_wrapper.rb]),
plus appropriate rspec examples.)
## History
Release Notes:
+* 0.9.0 - Expose Handle#md5_hash
* 0.8.0 - Include prefix in proxy_path (thus allowing cache sharing)
* 0.7.2 - Bug fix: don't fail when clearing cache if another process clears it first
* 0.7.1 - Add key info to message if there's an exception when getting file
* 0.7.0 - Add :query option to Handle#url
* 0.6.1 - Bug fix (caching)