diff --git a/README.md b/README.md index 414cfc5..1267061 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ [![Build Status](https://travis-ci.org/bkrukowski/gordianus.svg?branch=master)](https://travis-ci.org/bkrukowski/gordianus) [![Coverage Status](https://coveralls.io/repos/github/bkrukowski/gordianus/badge.svg?branch=master)](https://coveralls.io/github/bkrukowski/gordianus?branch=master) -[![Codacy Badge](https://api.codacy.com/project/badge/Grade/b057fa037a3b4f318f75af27b0b01d47)](https://www.codacy.com/app/bartlomiej-krukowski/gordianus?utm_source=github.com&utm_medium=referral&utm_content=bkrukowski/gordianus&utm_campaign=Badge_Grade) \ No newline at end of file +[![Codacy Badge](https://api.codacy.com/project/badge/Grade/b057fa037a3b4f318f75af27b0b01d47)](https://www.codacy.com/app/bartlomiej-krukowski/gordianus?utm_source=github.com&utm_medium=referral&utm_content=bkrukowski/gordianus&utm_campaign=Badge_Grade) + +# Gordianus + +Gordianus clears aliases from email address. Email John.Doe+alias@gmail.com will be transformed to johndoe@gmail.com. + +## Supported mailboxes + +* [gmail](https://gmail.com) +* [tlen.pl](http://tlen.pl) +* [33mail.com](https://www.33mail.com) + +## Usage + +```php +$gordianus = new \bkrukowski\Gordianus\Gordianus(); +$transformedEmail = $gordianus->getPrimaryEmail('John.Doe+alias@gmail.com'); +``` \ No newline at end of file