README.md in company_number-0.1.3 vs README.md in company_number-0.1.4
- old
+ new
@@ -78,22 +78,22 @@
```
Finally you can get the whole dictionary
```ruby
CompanyNumber.dictionary
-# => {:at=>{:country=>"Austria", :name=>"Firmenbuchnummer", :regexp=>"^([a-zA-Z]{2}\\d{1,6}|\\d{1,6})[A-Z]$", :pattern=>"2 letters + 6 numbers + 1 letter (LLXXXXXXL)", :variations=>"1-6 numbers + 1 letter (XXXXXXL)"}, ...}
+# => {:at=>{:country=>"Austria", :name=>"Firmenbuchnummer", :regexp=>"^([a-zA-Z]{2}\\d{1,6}|\\d{1,6})[A-Z]$", :pattern=>"2 letters + 6 numbers + 1 letter (LLXXXXXXL)", :variations=>["1-6 numbers + 1 letter (XXXXXXL)"]}, ...}
```
## Configuration
You can configure your own dictionary using **custom_dictionary**.
It should be a hash with the country codes as keys and the associated metadata as values.
Available metadata keys:
-- country
-- name
-- regexp
-- pattern
-- variations
+- country - *String*
+- name - *String*
+- regexp - *String*
+- pattern - *String*
+- variations - *Array*
**Example:**
```ruby
CompanyNumber.parse("123456789", :fr).valid? # => true
CompanyNumber.parse("12345678901234", :fr).valid? # => true