README.md in onfido-0.8.4 vs README.md in onfido-0.9.0
- old
+ new
@@ -10,13 +10,15 @@
## Installation
Add this line to your application's Gemfile:
```ruby
-gem 'onfido', '~> 0.8.4'
+gem 'onfido', '~> 0.9.0'
```
+The gem is compatible with Ruby 2.2.0 and onwards. Earlier versions of Ruby have [reached end-of-life](https://www.ruby-lang.org/en/news/2017/04/01/support-of-ruby-2-1-has-ended/), are no longer supported and no longer receive security fixes.
+
## Configuration
There are 5 configuration options:
```ruby
@@ -70,21 +72,27 @@
api.document.find('applicant_id', 'document_id') # => Finds a document
api.document.download('applicant_id', 'document_id') # => Downloads a document as a binary data
api.document.all('applicant_id') # => Returns all applicant's documents
```
-**Note:** The file parameter can be either a `File` object or a link to an image.
+**Note:** The file parameter must be a `File`-like object which responds to `#read` and `#path`.
+Previous versions of this gem supported providing a URL to a file accessible over HTTP or a path
+to a file in the local filesystem. You should instead load the file yourself and then pass it in
+to `#create`.
#### Live Photos
Live Photos, like documents, can provide supporting evidence for Onfido checks.
They can only be created - the Onfido does not support finding or listing them.
```ruby
api.live_photo.create('applicant_id', file: 'http://example.com')
```
-**Note:** The file parameter can be either a `File` object or a link to an image.
+**Note:** The file parameter must be a `File`-like object which responds to `#read` and `#path`.
+Previous versions of this gem supported providing a URL to a file accessible over HTTP or a path
+to a file in the local filesystem. You should instead load the file yourself and then pass it in
+to `#create`.
#### Checks
Checks are requests for Onfido to check an applicant, by commissioning one or
more "reports" on them.