README.md in verified-1.3.0 vs README.md in verified-1.3.1
- old
+ new
@@ -1,10 +1,27 @@
# Verified
A simple Ruby Gem to verify and parse MRZ codes on passports. Useful if you need to meet KYC or Money Laundering requirements.
+## Examples
+Setup a new instance
+```ruby
+passport = Verified::Passport.new("mrz_code_1", "mrz_code_2")
+```
+
+and you're done! Use it like this:
+
+```ruby
+passport.verified?
+# => true
+passport.last_name
+# => LAST
+passport.gender
+# => M
+```
+
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -48,10 +65,10 @@
personal_number : Personal number, if chosen to be given by issuer. Nil if not specified.
```
### UK Drivers License
-This is coming soon, as I'm currently waiting for the DVLA to respond to a [freedom of information request]() that will allow me to understand how the check digits in UK driver numbers are calculated.
+This is coming soon, as I'm currently waiting for the DVLA to respond to a freedom of information request that will allow me to understand how the check digits in UK driver numbers are calculated so I can verify them. Feel free to follow the [FOI request on WhatDoTheyKnow](https://www.whatdotheyknow.com/request/what_check_digit_algorithm_is_us#incoming-670731) and I'll update the gem as soon as I can once I have a response.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
\ No newline at end of file