Add - Readme & examples

Author: Andrei Igna

composer.json

@@ -1,7 +1,8 @@
 {
     "name": "layered/url-preview",
-    "description": "Get data from any URL from the internet",
+    "description": "Get preview data from any URL from the internet",
     "type": "library",
+    "keywords": ["scraper", "url-preview", "opengraph"],
     "require": {
         "fabpot/goutte": "^3.2"
     },

example.php

@@ -0,0 +1,42 @@
+<?php
+
+require 'vendor/autoload.php';
+
+
+echo '<pre>';
+
+echo '<h1>YouTube</h1>';
+print_r(Layered\UrlPreview::load('https://www.youtube.com/')->getData());
+print_r(Layered\UrlPreview::load('https://www.youtube.com/watch?v=3iTYpWfP0Og')->getData());
+
+echo '<h1>WordPress</h1>';
+print_r(Layered\UrlPreview::load('http://roberthajnal.ro/blog/2017/07/23/maraton-7500-2017/')->getData());
+print_r(Layered\UrlPreview::load('http://roberthajnal.ro/blog/2017/07/01/lavaredo-ultra-trail-la-ultra-si-cei-mai-buni-din-lume-se-taie/')->getData());
+
+echo '<h1>Medium</h1>';
+print_r(Layered\UrlPreview::load('https://rokm.ro/')->getData());
+print_r(Layered\UrlPreview::load('https://medium.com/@andrewcouldwell/plasma-design-system-4d63fb6c1afc')->getData());
+print_r(Layered\UrlPreview::load('https://rokm.ro/what-makes-a-good-fitness-app-b5416d410002')->getData());
+
+echo '<h1>Instagram</h1>';
+print_r(Layered\UrlPreview::load('https://instagram.com')->getData());
+print_r(Layered\UrlPreview::load('https://instagram.com/andreihere')->getData());
+print_r(Layered\UrlPreview::load('https://instagr.am/p/BYOgma8hoUK/')->getData());
+print_r(Layered\UrlPreview::load('https://www.instagram.com/p/BYjGxqkgQCm/?taken-by=daria_solak_illustrations')->getData());
+print_r(Layered\UrlPreview::load('https://www.instagram.com/p/BPezVTTjP7g/?taken-by=andreihere')->getData());
+
+echo '<h1>Facebook</h1>';
+print_r(Layered\UrlPreview::load('https://facebook.com')->getData());
+print_r(Layered\UrlPreview::load('https://facebook.com/andreiigna')->getData());
+print_r(Layered\UrlPreview::load('https://www.facebook.com/cciuca/posts/1857443374282334')->getData());
+print_r(Layered\UrlPreview::load('https://www.facebook.com/mxgur/posts/10107274070905477')->getData());
+print_r(Layered\UrlPreview::load('https://www.facebook.com/photo.php?fbid=1889887641037956&set=a.764654416894623.1073741851.100000502141017&type=3&theater')->getData());
+
+echo '<h1>Twitter</h1>';
+print_r(Layered\UrlPreview::load('https://twitter.com')->getData());
+print_r(Layered\UrlPreview::load('https://twitter.com/AndreiIgna')->getData());
+print_r(Layered\UrlPreview::load('https://twitter.com/AndreiIgna/status/903558303065759744')->getData());
+print_r(Layered\UrlPreview::load('https://twitter.com/AndreiIgna/status/890510906819571719')->getData());
+print_r(Layered\UrlPreview::load('https://twitter.com/AndreiIgna/status/902280395336626176')->getData());
+
+echo '</pre>';

readme.md

@@ -0,0 +1,59 @@
+URL Preview
+=========
+
+**URL Preview** is a PHP library than can get preview info on any URL from the internet! It uses data from [OpenGraph](http://ogp.me/) tags with fallback to HTML meta tags.
+
+## Use cases
+
+* Display Info Cards for links in a article
+* Rich preview for links in messaging apps
+* Enable file/image upload from URLs
+* *many more*
+
+## How to use
+
+#### Installation
+
+Add `layered/url-preview` as a require dependency in your `composer.json` file:
+
+#### Usage
+
+For each URL, create a `UrlPreview` instance with URL as first argument. Data is retrieved with `getData()` method:
+```
+$url = new Layered\UrlPreview('https://instagr.am/p/BYOgma8hoUK/');
+$urlData = $url->getData();
+
+// shorthand method
+$urlData = Layered\UrlPreview::load('https://instagr.am/p/BYOgma8hoUK/')->getData();
+```
+
+#### Preview data
+
+The returned data from URLs is an Array with the following structure:
+```
+[
+  'type'        =>  'photo',     // content type: website, article, photo, etc
+  'url'         =>  'https://www.instagram.com/p/BYOgma8hoUK/',   // processed URL: follows redirects, formatted by site
+  'title'       =>  'Instagram post by Andrei • Aug 25, 2017 at 6:23pm UTC',
+  'image'       =>  'https://scontent-mad1-1.cdninstagram.com/t51.2885-15/e35/21149037_113894809286463_3471808960858685440_n.jpg',
+  'description' =>  'Who needs a gym membership when there’s this? Outdoor gym, on the beach #barcelona #beach #gym…'
+]
+```
+Each URL may return extra fields, present in OpenGraph tags or added by a `Layered\UrlPreview\Formatter`. Example of `profile` field for Twitter & Instagram URLS:
+
+```
+[
+  // always present tags
+  'profile'     =>  [
+    'name'        =>  'Andrei',
+    'username'    =>  '@andreihere',
+    'url'         =>  'https://www.instagram.com/andreihere/'
+  ]
+]
+```
+
+
+## More
+
+Please report any issues here on GitHub.
+Any contributions are welcome (please get in touch before submitting a PR).

src/UrlPreview.php

@@ -34,7 +34,7 @@ public function __construct($url) {
 					if (!$this->previewer && $previewer->test($crawler)) {
 						$this->previewer = $previewer;
 						$this->data = $previewer->getData($crawler);
-						$this->data['previewer'] = $previewer->getName();
+						//$this->data['previewer'] = $previewer->getName();
 					}
 				}
 			}
@@ -77,6 +77,6 @@ public static function addFormatter($formatter, $priority = 10) {
 UrlPreview::addPreviewer(new Previewer\OpenGraph);
 UrlPreview::addPreviewer(new Previewer\SimpleHtml, 100);
 
-// Formatters to get extra Twitter & Instagram profile info 
+// Formatters to get extra Twitter & Instagram profile info
 UrlPreview::addFormatter(new Formatter\InstagramFromOpenGraph);
 UrlPreview::addFormatter(new Formatter\TwitterFields);