epafh/README.md
@@@No user configured@@@ 8a00803c41 Added code climate badge.
2015-11-25 00:24:43 +01:00

31 lines
976 B
Markdown

Epafh (Επαφή)
=============
[![Travis-CI](https://api.travis-ci.org/glenux/epafh.png?branch=master)](https://travis-ci.org)
[![Code Climate](https://codeclimate.com/github/glenux/epafh/badges/gpa.svg)](https://codeclimate.com/github/glenux/epafh)
Epafh (pronounce *\[epafí\]*), is a tool to extract all email addresses from your
mail boxes. Thus helping you into filling your CRM tool.
It starts by fetching existing email addresses from your CRM, then it connects
on your mailserver to read all emails and check for missing contacts in your
CRM.
For the moment it only supports IMAP mail servers and FatFreeCRM servers.
The next move on the roadmap is POP3 support and maybe some other CRM.
## Installation
With ruby installed on your system, simply type :
$ gem install epafh
## Usage
TODO: Write usage instructions here
## License
The gem is available as open source under the terms of the [LGPL-3 License](http://opensource.org/licenses/LGPL-3.0).