Permalink
Browse files

Merge pull request #49 from rgercp/master

Update README
  • Loading branch information...
2 parents 25f95fe + 00dbc2c commit 5d1fa9dc4871e2e1b1b4ca8418538a8cdc0ba972 Lucas Carlson committed Apr 7, 2014
Showing with 35 additions and 24 deletions.
  1. +31 −20 README → README.md
  2. +4 −4 test/example_accounts.yml
View
@@ -1,46 +1,57 @@
-== Welcome to Contacts
+Welcome to Contacts
+===================
Contacts is a universal interface to grab contact list information from various providers including Hotmail, AOL, Gmail, Plaxo and Yahoo.
-== Download
+Download
+--------
* gem install contacts
* http://github.com/cardmagic/contacts
* git clone git://github.com/cardmagic/contacts.git
-== Background
+Background
+----------
For a long time, the only way to get a list of contacts from your free online email accounts was with proprietary PHP scripts that would cost you $50. The act of grabbing that list is a simple matter of screen scrapping and this library gives you all the functionality you need. Thanks to the generosity of the highly popular Rails website MOG (http://mog.com) for allowing this library to be released open-source to the world. It is easy to extend this library to add new free email providers, so please contact the author if you would like to help.
-== Usage
-
- Contacts::Hotmail.new(login, password).contacts # => [["name", "foo@bar.com"], ["another name", "bow@wow.com"]]
- Contacts::Yahoo.new(login, password).contacts
- Contacts::Gmail.new(login, password).contacts
-
- Contacts.new(:gmail, login, password).contacts
- Contacts.new(:hotmail, login, password).contacts
- Contacts.new(:yahoo, login, password).contacts
-
- Contacts.guess(login, password).contacts
+Usage
+-----
+
+<pre>
+ <code>
+ Contacts::Hotmail.new(login, password).contacts # => [["name", "foo@bar.com"], ["another name", "bow@wow.com"]]
+ Contacts::Yahoo.new(login, password).contacts
+ Contacts::Gmail.new(login, password).contacts
+ Contacts.new(:gmail, login, password).contacts
+ Contacts.new(:hotmail, login, password).contacts
+ Contacts.new(:yahoo, login, password).contacts
+ Contacts.guess(login, password).contacts
+ </code>
+</pre>
Notice there are three ways to use this library so that you can limit the use as much as you would like in your particular application. The Contacts.guess method will automatically concatenate all the address book contacts from each of the successful logins in the case that a username password works across multiple services.
-== Captcha error
+Captcha error
+-------------
If there are too many failed attempts with the gmail login info, Google will raise a captcha response. To integrate the captcha handling, pass in the token and response via:
-
+<pre><code>
Contacts::Gmail.new(login, password, :captcha_token => params[:captcha_token], :captcha_response => params[:captcha_response]).contacts
+</code></pre>
-== Examples
+Examples
+--------
See the examples/ directory.
-== Authors
+Authors
+-------
-* Lucas Carlson from MOG (mailto:lucas@rufy.com) - http://mog.com
+> Lucas Carlson from MOG (mailto:lucas@rufy.com) - http://mog.com
-== Contributors
+Contributors
+------------
* Britt Selvitelle from Twitter (mailto:anotherbritt@gmail.com) - http://twitter.com
* Tony Targonski from GigPark (mailto:tony@gigpark.com) - http://gigpark.com
@@ -1,7 +1,7 @@
gmail:
username: <changeme>
password: <changeme>
- contacts:
+ contacts:
-
name: "FirstName1 LastName1"
email_address: "firstname1@example.com"
@@ -11,7 +11,7 @@ gmail:
yahoo:
username: <changeme>
password: <changeme>
- contacts:
+ contacts:
-
name: "FirstName1 LastName1"
email_address: "firstname1@example.com"
@@ -21,7 +21,7 @@ yahoo:
hotmail:
username: <changeme>
password: <changeme>
- contacts:
+ contacts:
-
name: "FirstName1 LastName1"
email_address: "firstname1@example.com"
@@ -31,7 +31,7 @@ hotmail:
aol:
username: <changeme>
password: <changeme>
- contacts:
+ contacts:
-
name: "FirstName1 LastName1"
email_address: "firstname1@example.com"

0 comments on commit 5d1fa9d

Please sign in to comment.