From 1c58e86d0a830577f4095cb681dc0922a913676e Mon Sep 17 00:00:00 2001
From: Clivern <hello@clivern.com>
Date: Mon, 14 Aug 2017 14:18:20 +0200
Subject: [PATCH] README updated

---
 README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 55 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index d8320ab..37bbcce 100644
--- a/README.md
+++ b/README.md
@@ -8,15 +8,68 @@ Imap
 
 Installation
 ------------
-To install the package, use the following:
+To install the package via `composer`, use the following:
 ```php
-#
+composer require clivern/file_uploader
 ```
 
 Usage
 -----
 After adding the package as a dependency, Please read the following steps:
 
+First configure connection class.
+```php
+include_once dirname(__FILE__) . '/vendor/autoload.php';
+
+$connection = new Clivern\Imap\Core\Connection("imap.gmail.com", "993", "test@clivern.com", "my_password", "/ssl", "INBOX");
+$connection->connect();
+```
+
+To add custom search
+```php
+$search = new Clivern\Imap\Core\Search();
+$search->addCondition(new Clivern\Imap\Core\Search\Condition\All());
+// $search->addCondition(new Clivern\Imap\Core\Search\Condition\Answered());
+// $search->addCondition(new Clivern\Imap\Core\Search\Condition\BCC("filter@gmail.com"));
+// $search->addCondition(new Clivern\Imap\Core\Search\Condition\Before(date("j F Y")));
+// $search->addCondition(new Clivern\Imap\Core\Search\Condition\Body("search text"));
+// $search->addCondition(new Clivern\Imap\Core\Search\Condition\CC("filter@gmail.com"));
+// $search->addCondition(new Clivern\Imap\Core\Search\Condition\Deleted());
+// $search->addCondition(new Clivern\Imap\Core\Search\Condition\Flagged());
+// $search->addCondition(new Clivern\Imap\Core\Search\Condition\From("filter@gmail.com"));
+// $search->addCondition(new Clivern\Imap\Core\Search\Condition\Keyword("test"));
+// $search->addCondition(new Clivern\Imap\Core\Search\Condition\NewFlag());
+// $search->addCondition(new Clivern\Imap\Core\Search\Condition\Old());
+// $search->addCondition(new Clivern\Imap\Core\Search\Condition\On(date("j F Y")));
+// $search->addCondition(new Clivern\Imap\Core\Search\Condition\Recent());
+// $search->addCondition(new Clivern\Imap\Core\Search\Condition\Seen());
+// $search->addCondition(new Clivern\Imap\Core\Search\Condition\Since(date("j F Y")));
+// $search->addCondition(new Clivern\Imap\Core\Search\Condition\Subject("search text"));
+// $search->addCondition(new Clivern\Imap\Core\Search\Condition\Text("search text"));
+// $search->addCondition(new Clivern\Imap\Core\Search\Condition\To("filter@gmail.com"));
+// $search->addCondition(new Clivern\Imap\Core\Search\Condition\UnAnswered());
+// $search->addCondition(new Clivern\Imap\Core\Search\Condition\UnDeleted());
+// $search->addCondition(new Clivern\Imap\Core\Search\Condition\UnFlagged());
+// $search->addCondition(new Clivern\Imap\Core\Search\Condition\UnKeyword("test"));
+// $search->addCondition(new Clivern\Imap\Core\Search\Condition\UnSeen());
+
+// For more info, please check http://php.net/manual/en/function.imap-search.php
+```
+
+Then configure mailbox:
+
+```php
+$mailbox = new Clivern\Imap\MailBox($connection);
+
+$messages = $mailbox->getMessages($search);
+
+foreach ($messages as $message) {
+	echo "Subject: " . $message->header()->get('subject');
+	echo "<br/>";
+	echo $message->body()->getMessage();
+}
+```
+
 
 Misc
 ====