README.md in myna_bird-0.2.11 vs README.md in myna_bird-0.2.12

- old
+ new

@@ -23,33 +23,39 @@ (like Comcast or Gmail), then MynaBird uses the local part of their address as the name. Otherwise, MynaBird builds the account name from the domain. For example: - brendan@wistia.com -> wistia - brendan.schwartz@gmail.com -> brendan-schwartz - brendan+nospam@gmail.com -> brendan - support@gmail.com -> support-at-gmail + brendan@wistia.com -> wistia + brendan.schwartz@gmail.com -> brendan-schwartz + brendan+nospam@gmail.com -> brendan + support@gmail.com -> support-at-gmail Ok, that last one is a bit of a special case, but you get the idea. -Usage: +## Usage - require 'myna_bird' - MynaBird.convert('brendan@wistia.com') #=> 'wistia' + require 'myna_bird' + MynaBird.convert('brendan@wistia.com') #=> 'wistia' +You can also tell MynaBird to avoid a list of domains. No need to include the +TLD, just a second-level domain. For example: -Specs: + MynaBird.avoid_domains = ['coolmail', 'bestmail'] + MynaBird.convert('best.business@coolmail.com') #=> 'best-business' + +## Specs + Just run "rake spec" to run the specs. Don't be shy, feel free to add more examples. -Questions: +## Questions Feel free to email me at brendan@wistia.com with any questions. -License: +## License: Go nuts. See LICENSE for full details.