finalization of readme

Author: ricardofiorani

README.md

@@ -1,5 +1,58 @@
 # PHP Video URL Parser
-Simple Video Parser in PHP
+PHP Video URL Parser receives an video service URL (Like Youtube or VIMEO) and returns an object containing some video info
+such as Thumnail's, Video Title, Video Description.
+
+## Installation
+
+Install the latest version with
+
+```bash
+$ composer require ricardofiorani/ricardofiorani/php-video-url-parser
+```
+
+## Basic Usage
+
+```php
+<?php
+use RicardoFiorani\Detector\VideoServiceDetector;
+
+require __DIR__ . '/vendor/autoload.php';
+
+$vsd = new VideoServiceDetector();
+
+//Detects wich service the url belongs to and returns the service's implementation
+//of RicardoFiorani\Adapter\VideoAdapterInterface
+$video = $vsd->parse('https://www.youtube.com/watch?v=PkOcm_XaWrw');
+
+//Checks if service provides embeddable videos (most services does)
+if ($video->isEmbeddable()) {
+    //Will echo the embed html element with the size 200x200
+    echo $video->getEmbedCode(200, 200);
+
+    //Returns the embed html element with the size 1920x1080 and autoplay enable
+    echo $video->getEmbedCode(1920, 1080, true);
+}
+
+//If you don't want to check if service provides embeddable videos you can try/catch
+try {
+    echo $video->getEmbedUrl();
+} catch (\RicardoFiorani\Exception\NotEmbeddableException $e) {
+    die(sprintf("The URL %s service does not provide embeddable videos.", $video->getRawUrl()));
+}
+
+//Gets URL of the smallest thumbnail size available
+echo $video->getSmallThumbnail();
+
+//Gets URL of the largest thumbnail size available
+//Note some services (such as Youtube) does not provide the largest thumbnail for some low quality videos (like the one used in this example)
+echo $video->getLargestThumbnail();
+```
+
+## Registering your own service video (it's easy !)
+If you want to register an implementation of some service your class just needs to implement the "RicardoFiorani\Adapter\VideoAdapterInterface" or extend the RicardoFiorani\Adapter\AbstractServiceAdapter
+
+A Fully functional example can be found [Here](https://github.com/ricardofiorani/php-video-url-parser/tree/master/example/RegisteringANewService.md)
+
 
 # TODO List goals for release 1.0:
 

src/Detector/VideoDetector.php renamed to src/Detector/VideoServiceDetector.php

@@ -10,7 +10,7 @@
 /**
  * @author Ricardo Fiorani
  */
-class VideoDetector
+class VideoServiceDetector
 {
     /**
      * @var array

src/Exception/NotEmbedableException.php renamed to src/Exception/NotEmbeddableException.php

@@ -11,7 +11,7 @@
 
 use Exception;
 
-class NotEmbedableException extends Exception
+class NotEmbeddableException extends Exception
 {
 
 }