From 5e37af5d69da3140cb3d6b1bd0264a3cd26a500d Mon Sep 17 00:00:00 2001
From: Vito Albano <valbano@MacPro.local>
Date: Tue, 8 Nov 2016 17:47:43 +0000
Subject: [PATCH] Updated readme for the new changes

---
 .../ng2-alfresco-userinfo/README.md           | 52 ++++++++++++++++++-
 1 file changed, 50 insertions(+), 2 deletions(-)

diff --git a/ng2-components/ng2-alfresco-userinfo/README.md b/ng2-components/ng2-alfresco-userinfo/README.md
index 247591e3ef..5c11357cba 100644
--- a/ng2-components/ng2-alfresco-userinfo/README.md
+++ b/ng2-components/ng2-alfresco-userinfo/README.md
@@ -1,5 +1,38 @@
 # Alfresco User Info Component for Angular 2
-This component will show the user information for ECM and BPM
+<p>
+  <a title='Build Status Travis' href="https://travis-ci.org/Alfresco/alfresco-ng2-components">
+    <img src='https://travis-ci.org/Alfresco/alfresco-ng2-components.svg?branch=master'  alt='travis
+    Status' />
+  </a>
+  <a title='Build Status AppVeyor' href="https://ci.appveyor.com/project/alfresco/alfresco-ng2-components">
+    <img src='https://ci.appveyor.com/api/projects/status/github/Alfresco/alfresco-ng2-components'  alt='travis
+    Status' />
+  </a>
+  <a href='https://codecov.io/gh/Alfresco/alfresco-ng2-components'>
+    <img src='https://img.shields.io/codecov/c/github/Alfresco/alfresco-ng2-components/master.svg?maxAge=2592000' alt='Coverage Status' />
+  </a>
+  <a href='https://www.npmjs.com/package/ng2-alfresco-login'>
+    <img src='https://img.shields.io/npm/dt/ng2-alfresco-login.svg' alt='npm downloads' />
+  </a>
+  <a href='https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE'>
+     <img src='https://img.shields.io/hexpm/l/plug.svg' alt='license' />
+  </a>
+  <a href='https://www.alfresco.com/'>
+     <img src='https://img.shields.io/badge/style-component-green.svg?label=alfresco' alt='alfresco component' />
+  </a>
+  <a href='https://angular.io/'>
+     <img src='https://img.shields.io/badge/style-2-red.svg?label=angular' alt='angular 2' />
+  </a>
+  <a href='https://www.typescriptlang.org/docs/tutorial.html'>
+     <img src='https://img.shields.io/badge/style-lang-blue.svg?label=typescript' alt='typescript' />
+  </a>
+  <a href='https://www.alfresco.com/'>
+     <img src='https://img.shields.io/badge/style-%3E5.0.0-blue.svg?label=node%20version' alt='node version' />
+  </a>
+</p>
+
+### Node
+To correctly use this component check that on your machine is running Node version 5.0.0 or higher.
 
 
 ## Prerequisites
@@ -48,9 +81,24 @@ Also make sure you include these dependencies in your `index.html` file:
 	
 ## Example
 
+## Basic usage
+
 ```html
-<ng2-alfresco-userinfo></ng2-alfresco-userinfo>
+<alfresco-document-list
+    [ecmBackgroundImage]="pathToEcmBannerImage"
+    [bpmBackgroundImage]="pathToBpmBannerImage"
+    [fallBackThumbnailImage]="pathToDefaultImage">
+</alfresco-document-list>
 ```
+
+### Properties
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| ecmBackgroundImage | string |  | Custom path for the background banner image for ECM users |
+| bpmBackgroundImage | string |  | Custom path for the background banner image for BPM users |
+| fallBackThumbnailImage | string | ng2-alfresco-userinfo/src/img/anonymous.gif | Fallback image for profile when thubnail is missing|
+
 This will show a round icon with user and on click some user information are showed.
 If user is logged in with ECM and BPM the ECM image will be showed.