From 0d0c4a3e434fc28f0f68b5421e49a206dfe04160 Mon Sep 17 00:00:00 2001
From: Abed Halawi <halawi.abed@gmail.com>
Date: Tue, 1 Sep 2015 19:25:15 +0300
Subject: [PATCH] update readme

---
 README.md | 79 ++++++++++++++++++++++++++++++-------------------------
 1 file changed, 43 insertions(+), 36 deletions(-)

diff --git a/README.md b/README.md
index 2c812c2..0ca6143 100644
--- a/README.md
+++ b/README.md
@@ -2,9 +2,10 @@
 
 ## RSS 2.0 Client
 
-## Installation
-Refer to [vinelab/rss on packagist.org](https://packagist.org/packages/vinelab/rss) for composer installation instructions.
+### Installation
+`composer require vinelab/rss`
 
+#### Laravel Setup
 Edit **app.php** and add ```'Vinelab\Rss\RssServiceProvider',``` to the ```'providers'``` array.
 
 It will automatically alias itself as **RSS** so no need to aslias it in your **app.php** unless you would like to customize it. In that case edit your **'aliases'** in **app.php** adding ``` 'MyRSS'    => 'Vinelab\Rss\Facades\RSS',```
@@ -12,53 +13,59 @@ It will automatically alias itself as **RSS** so no need to aslias it in your **
 ## Usage
 
 ### Fetch an RSS feed
+> Assuming (and hoping) that you're using [Composer](http://getcomposer.org) to manage your project's dependencies.
+
 ```php
-<?php
+require 'vendor/autoload.php';
+
+use Vinelab\Rss\Rss;
 
-$feed = RSS::feed('http://feeds.reuters.com/news/artsculture');
+$rss = new Rss();
+$feed = $rss->feed('http://feeds.reuters.com/news/artsculture');
 
 // $feed is now an instance of Vinelab\Rss\Feed
 
 $count = $feed->articlesCount(); // 10
+```
 
+#### Feed Info
+```php
 $info = $feed->info();
 
-/*
- info:
-
-array (size=7)
-  'title' => string 'Reuters: Arts' (length=13)
-  'link' => string 'http://www.reuters.com' (length=22)
-  'description' => string 'Reuters.com is your source for breaking news, business, financial and investing news, including personal finance and stocks.  Reuters is the leading global provider of news, financial information and technology solutions to the world's media, financial institutions, businesses and individuals.' (length=294)
-  'image' =>
-    object(SimpleXMLElement)[214]
-      public 'title' => string 'Reuters News' (length=12)
-      public 'width' => string '120' (length=3)
-      public 'height' => string '35' (length=2)
-      public 'link' => string 'http://www.reuters.com' (length=22)
-      public 'url' => string 'http://www.reuters.com/resources_v2/images/reuters125.png' (length=57)
-  'language' => string 'en-us' (length=5)
-  'lastBuildDate' => string 'Mon, 16 Dec 2013 07:37:00 -0500' (length=31)
-  'copyright' => string 'All rights reserved. Users may download and print extracts of content from this website for their own personal and non-commercial use only. Republication or redistribution of Reuters content, including by framing or similar means, is expressly prohibited without the prior written consent of Reuters. Reuters and the Reuters sphere logo are registered trademarks or trademarks of the Reuters group of companies around the world. © Reuters 2013' (length=444)
-*/
+echo json_encode($info);
+```
+
+```json
+{
+    "title":"Reuters: Arts",
+    "link":"http:\/\/www.reuters.com",
+    "description":"Reuters.com is your source for breaking news, business, financial and investing news, including personal finance and stocks.  Reuters is the leading global provider of news, financial information and technology solutions to the world's media, financial institutions, businesses and individuals.",
+    "image":{
+        "title":"Reuters News",
+        "width":"120",
+        "height":"35",
+        "link":"http:\/\/www.reuters.com",
+        "url":"http:\/\/www.reuters.com\/resources_v2\/images\/reuters125.png"
+    },
+    "language":"en-us",
+    "lastBuildDate":"Tue, 01 Sep 2015 11:25:09 -0400",
+    "copyright":"All rights reserved. Users may download and print extracts of content from this website for their own personal and non-commercial use only. Republication or redistribution of Reuters content, including by framing or similar means, is expressly prohibited without the prior written consent of Reuters. Reuters and the Reuters sphere logo are registered trademarks or trademarks of the Reuters group of companies around the world. \u00a9 Reuters 2015"
+}
+```
 
+#### Feed Articles
+```php
 $articles = $feed->articles();
+```
 
-/*
-    articles:
+This will give you a collection of articles, of Vinelab\Rss\ArticlesCollection which is
+an extension of Illuminate\Support\Collection. Each item of this collection is an instance
+of Vinelab\Rss\Article from which you can safely access any of the properties you wish.
 
-    This is a child from Illuminate\Support\Collection, which means
-    you can apply any of the applicable functionalities to it.
+```php
+$article = $articles->first();
 
-    object(Vinelab\Rss\ArticlesCollection)[213]
-      protected 'items' =>
-        array (size=10)
-          0 =>
-            object(Vinelab\Rss\Article)[236]
-              protected 'info' =>
-                array (size=6)
-                  ...
- */
+echo $article->title; // ABBA piano seen raising money, money, money at auction
 
-//
+echo $article->whatever; // null
 ```