Permalink
Browse files

Added more information to the README.md file.

  • Loading branch information...
1 parent 812e4eb commit 5293e0e98663b5e075f3f7201059891e02063fc1 @Lumbendil Lumbendil committed Sep 18, 2012
Showing with 31 additions and 1 deletion.
  1. +31 −1 README.md
View
@@ -8,4 +8,34 @@ Fetch was part of a large project, Mortar, which is hosted on Google Code. It is
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.
+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";
+ }

0 comments on commit 5293e0e

Please sign in to comment.