readme examples

Author: web64

README.md

@@ -1,5 +1,5 @@
 # Laravel NLP
-A simple wrapper for PHP-NLP-Client and OpenCalais NLP tools.
+A simple wrapper for PHP-NLP-Client for accessing Python and Java NLP libraries.
 
 ## Installation
 
@@ -9,13 +9,18 @@ $ composer require web64/laravel-nlp
 
 ## Requirements
 
+## NLP Server
+This package requires a running instance of the NLP Server [https://github.com/web64/nlpserver]
+
 ## Included Tools
 
 * Article Extraction
 * Language Detection
 * Entity Extraction (Named Entity Recognition)
 * Sentiment Analysis
-* 
+* Summarization
+* Translation
+* Embeddings - Neighbouring Words
 
 ## Usage
 
@@ -49,8 +54,36 @@ print_r($article);
 ```
 
 ### Entity Extraction
+```php
+$text = "Barack Hussein Obama is an American politician who served as the 44th President of the United States from January 20, 2009 to January 20, 2017. Before that, he served in the Illinois State Senate from 1997 until 2004.";
 
+$entities = NLP::entities( $text, 'en' );
+/*
+Array
+(
+    [0] => Barack Hussein Obama
+    [1] => American
+    [2] => United States
+    [3] => Illinois
+)
+*/
+```
 ### Sentiment Analysis
+```php
+$sentiment = NLP::sentiment( "This is great!" );
+// 1
+
+$sentiment = NLP::sentiment( "I hate this product" );
+// -1
+```
+### Summarization
+### Translation
+Second parameter is the source language. Language will be automatically detected if left as NULL
+
+```php
+$translated_text = NLP::translate("Mange er opprørt etter avsløringene om at persondata for 87 millioner Facebook-brukere skal være på avveie", null, 'pt');
+// 'Muitas pessoas estão chateadas após a divulgação de que os dados pessoais de 87 milhões de usuários do Facebook devem estar fora de ordem'
+```
 
 ### Concepts
 ### Embeddings