Merge pull request #7 from Wiakowe/updated-readme

Added more information to the README.md file.
This commit is contained in:
Robert Hafner 2012-09-18 11:53:00 -07:00
commit 3f5cd124e3

View File

@ -9,3 +9,33 @@ currently being migrated over to Github, as well as being updated to support
modern php features. While the project is in flux I encourage you to try it out,
but be careful about using it in a production environment without proper
testing.
Installation
============
The most easy way to install the library is via composer. To do so, you have to do
the following:
php composer.phar require tedivm/fetch
Composer will then ask you which version you want to install. Until there are stable
versions, by using "@dev" it'll install the latest version.
Sample Usage
============
This is just a simple code to show how to access messages by using Fetch. It uses Fetch
own autoload, but it can (and should be, if applicable) replaced with the one generated
by composer.
require 'autoload.php';
$server = new \Fetch\Server('imap.example.com', 993);
$server->setAuthentication('dummy', 'dummy');
$messages = $server->getMessages();
/** @var $message \Fetch\Message */
foreach ($messages as $message) {
echo "Subject: {$message->getSubject()}\nBody: {$message->getMessageBody()}\n";
}