diff --git a/README.md b/README.md index 396a348..7c0ba64 100644 --- a/README.md +++ b/README.md @@ -12,38 +12,37 @@ The gem should be compatible with most Ruby versions. ## USAGE - require 'iban-tools' +```rb +require 'iban-tools' - IBANTools::IBAN.valid?("GB82 WEST 1234 5698 7654 32") - => true +IBANTools::IBAN.valid?("GB82 WEST 1234 5698 7654 32") #=> true +``` Advanced usage, gives more detailed error messages - IBANTools::IBAN.new("XQ75 BADCODE 666").validation_errors - => [:unknown_country_code, :bad_check_digits] +```rb +IBANTools::IBAN.new("XQ75 BADCODE 666").validation_errors +# => [:unknown_country_code, :bad_check_digits] +``` Pretty print, canonicalize, and extract fields from an IBAN code - iban = IBANTools::IBAN.new(" ro49 aaaa 1B31007593840000") +```rb +iban = IBANTools::IBAN.new(" ro49 aaaa 1B31007593840000") - iban.code - => "RO49AAAA1B31007593840000" +iban.code # => "RO49AAAA1B31007593840000" +iban.country_code # => "RO" +iban.prettify # => "RO49 AAAA 1B31 0075 9384 0000" +``` + +Convert local account numbers to IBAN and back to local. - iban.country_code - => "RO" +```rb +iban = IBANTools::IBAN.from_local('NO', bank_code: '9710', account_number: '1112222', check_digit: '7') - iban.prettify - => "RO49 AAAA 1B31 0075 9384 0000" - -Convert local account numbers to IBAN and back to local. - - iban = IBANTools::IBAN.from_local('NO', bank_code: '9710', account_number: '1112222', check_digit: '7') - - iban.code - => "NO6197101112227" - - iban.to_local - => {:bank_code=>"9710", :account_number=>"111222", :check_digit=>"7"} +iban.code # => "NO6197101112227" +iban.to_local # => {:bank_code=>"9710", :account_number=>"111222", :check_digit=>"7"} +``` ## Credit