README.md in gman-0.0.7 vs README.md in gman-0.1.0
- old
+ new
@@ -26,16 +26,36 @@
```ruby
Gman.valid? "foo@bar.gov" #true
Gman.valid? "foo@bar.com" #false
```
+
+### Really verify an email address
+
+(also verifies that the server returns a valid MX record)
+
+```ruby
+Gman.valid? "foo@whitehouse.gov", true #true
+Gman.valid? "foo@bar.gov", true #false
+```
### Verify domain
```ruby
Gman.valid? "http://foo.bar.gov" #true
Gman.valid? "foo.bar.gov" #true
Gman.valid? "foo.gov" #true
Gman.valid? "foo.biz" #false
+```
+
+### Get a domain name from an arbitrary domainy string
+
+```ruby
+Gman.get_domain "http://foo.bar.gov" # foo.bar.gov
+Gman.get_domain "foo@bar.gov" # bar.gov
+Gman.get_domain "foo.bar.gov" # foo.bar.gov
+Gman.get_domain "asdf@asdf" # nil (no domain within the string)
+Gman.get_domain "foo@bar.gov", true #false (no MX record)
+Gman.get_domain "foo@whitehouse.gov", true # true (valid MX record)
```
## Contributing
Contributions welcome! Please see [the contribution guidelines](CONTRIBUTING.md) for code contributions or for details on how to add, update, or delete government domains.