diff --git a/README.md b/README.md index 6c88960..f2567f6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,49 @@ # email-alias +

+ + + + + + + + Follow me on Twitter + +

+ Create a email alias easly from CLI ! + +## Install + +To install this package use the command below : + +`npm install -g @vafanassieff/email-alias` + +### Update + +To update the package run `npm update -g @vafanassieff/email-alias` + +## Usage + +```Shell +Usage: email-alias [options] [command] + +Manage email alias + +Options: + -V, --version output the version number + -h, --help display help for command + +Commands: + list List current alias + add [options] Add a new alias + remove Add a new alias + provider + help [command] display help for command +``` + +## Providers + +At the moment there is only OVH as an email alias provider