README.md in riiif-2.1.0 vs README.md in riiif-2.2.0
- old
+ new
@@ -1,11 +1,11 @@
# Riiif
[](http://badge.fury.io/rb/riiif)
[](https://coveralls.io/github/curationexperts/riiif?branch=master)
-A Ruby IIIF image server as a rails engine
+A Ruby IIIF image server as a rails engine. Note that RIIIF is meant for development convenience and will not scale to the needs of most production-level applications.
## Installation
RIIIF depends on Imagemagick so you must install that first. On a mac using Homebrew you can follow these instructions:
@@ -46,11 +46,11 @@
```
### Images retrieved over HTTP
It's preferable to use files on the filesystem, because this avoids the overhead of downloading the file. If this is unavoidable, Riiif can be configured to fetch files from the network. To enable this behavior, configure Riiif to use an alternative resolver:
```
- Riiif::Image.file_resolver = Riiif::HTTPFileResolver.new
+ Riiif::Image.file_resolver = Riiif::HttpFileResolver.new
```
Then we configure the resolver with a mechanism for mapping the provided id to a url:
```
Riiif::Image.file_resolver.id_to_uri = lambda do |id|
"http://upload.wikimedia.org/wikipedia/commons/thumb/a/a4/#{id}.jpg/600px-#{id}.jpg"
@@ -152,10 +152,10 @@
Create an initializer like this in `config/initializers/riiif_initializer.rb`
```ruby
# Tell RIIIF to get files via HTTP (not from the local disk)
-Riiif::Image.file_resolver = Riiif::HTTPFileResolver.new
+Riiif::Image.file_resolver = Riiif::HttpFileResolver.new
# This tells RIIIF how to resolve the identifier to a URI in Fedora
Riiif::Image.file_resolver.id_to_uri = lambda do |id|
ActiveFedora::Base.id_to_uri(CGI.unescape(id)).tap do |url|
logger.info "Riiif resolved #{id} to #{url}"