README.md in lite-address-1.0.1 vs README.md in lite-address-1.1.0
- old
+ new
@@ -29,53 +29,57 @@
Parsing an address will return a `Lite::Address::Format` object which responds to the
methods below (check the class to see more). If an address cannot be parsed then nil
will be returned, but partial matches can be returned. All addresses will try to be
normalized to return a predictable pattern.
+#### Full matches
```
-address = Lite::Address::Parse.parse("1600 Pennsylvania Ave, Washington, DC, 20500")
+address = Lite::Address::Parser.any("1600 Pennsylvania Ave, Washington, DC, 20500")
address.street #=> Pennsylvania
address.number #=> 1600
address.postal_code #=> 20500
address.city #=> Washington
address.state #=> DC
address.state_name #=> District of Columbia
address.street_type #=> Ave
address.intersection? #=> false
+```
-address = Lite::Address::Parse.parse("1600 Pennsylvania Ave")
+#### Partial matches
+```
+address = Lite::Address::Parser.any("1600 Pennsylvania Ave")
address.street #=> Pennsylvania
address.number #=> 1600
address.state #=> nil
-
-address = Lite::Address::Parse.parse("5904 Richmond Hwy Ste 340 Alexandria VA 22303-1864")
-address.postal_code_ext #=> 1846
-
-address = Lite::Address::Parse.parse("5904 Richmond Hwy Ste 340 Alexandria VA 223031864")
-address.postal_code_ext #=> 1846
```
## Formatting
A formatted can be returned to as a whole or in parts of simple strings.
```
-address = Lite::Address::Parse.parse("1600 Pennsylvania Ave, Washington, DC, 20500")
+address = Lite::Address::Parser.any("1600 Pennsylvania Ave, Washington, DC, 20500")
address.to_s #=> 1600 Pennsylvania Ave, Washington, DC 20500
address.to_s(:line1) #=> 1600 Pennsylvania Ave
address.to_s(:line2) #=> Washington, DC 20500
```
You can also format strings to the proper country mail format.
+#### Address only
```
-address = Lite::Address::Parse.parse("1600 Pennsylvania Ave, Washington, DC, 20500")
-address.to_snail #=> 1600 Pennsylvania Ave,
- Washington, DC 20500
+address = Lite::Address::Parser.any("1600 Pennsylvania Ave, Washington, DC, 20500")
+address.to_snail #=> 1600 Pennsylvania Ave,
+ Washington, DC 20500
-address.to_snail(name: 'John Doe') #=> John Doe
- 1600 Pennsylvania Ave,
- Washington, DC 20500
+```
+
+#### Name prepended
+```
+address = Lite::Address::Parser.any("1600 Pennsylvania Ave, Washington, DC, 20500")
+address.to_snail(name: 'John Doe') #=> John Doe
+ 1600 Pennsylvania Ave,
+ Washington, DC 20500
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.