File: doc/README

* What is this?
------------------------------------------------------
GmAtom is made to be a quick and easy solution to a simple task of 
programmatically checking new mail on Gmail accounts, using Gmail
Atom feeds.


* What can I do with this?
------------------------------------------------------
You can check for new mail on one or more accounts and obtain the basic 
info on new messages - from, subject, date, link to full message and a 
body excerpt. You can check new mail for the entire inbox, or just for
certain label(s).

For anything that exceeds this simple purpose, you're perhaps better off 
using libgmailer:
http://gmail-lite.sourceforge.net/wordpress/index.php/about/libgmailer


* What do I need to run this?
------------------------------------------------------
You need curl PHP extension.


* How do I use this?
------------------------------------------------------
Check the examples in "examples" directory (please, do remember to provide 
valid gmail username and password before you expect them to work). You can 
also take a look at comments in the source, or run PhpDocumentor 
(http://www.phpdoc.org) over it to get a more readable documentation.


* Aaargh! I've found a bug!
  - OR -
* This GmAtom stuff is working fine for me.
  - OR -
* Dis nuh workin.
  - OR -
* Dude, I think you rock!
------------------------------------------------------
Let me know: malatestapunk@gmail.com