diff --git a/ng2-components/ng2-alfresco-userinfo/README.md b/ng2-components/ng2-alfresco-userinfo/README.md index fe8a836e34..f100be7287 100644 --- a/ng2-components/ng2-alfresco-userinfo/README.md +++ b/ng2-components/ng2-alfresco-userinfo/README.md @@ -1,28 +1,58 @@ -# ng2-alfresco-userinfo +# Alfresco User Info Component for Angular 2 This component will show the user information for ECM and BPM + +## Prerequisites + +Before you start using this development framework, make sure you have installed all required software and done all the +necessary configuration, see this [page](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md). + ## Installation ```bash npm install ng2-alfresco-userinfo --save ``` +## Dependencies +Add the following dependency to your index.html: +```html + +``` + +You must separately install the following libraries for your application: + +- [ng2-translate](https://github.com/ocombe/ng2-translate) +- [ng2-alfresco-core](https://www.npmjs.com/package/ng2-alfresco-core) + +```sh +npm install --save ng2-translate ng2-alfresco-core +``` + +#### Material Design Lite + +The style of this component is based on [material design](https://getmdl.io/), so if you want to visualize it correctly you have to add the material +design dependency to your project: + +```sh +npm install --save material-design-icons material-design-lite +``` + +Also make sure you include these dependencies in your `index.html` file: + +```html + + + + +``` + ## Example ```html ``` - -## Reference - -Attribute | Options | Default | Description ---- | --- | --- | --- -`foo` | *string* | `bar` | Lorem ipsum dolor. - - -Method | Parameters | Returns | Description ---- | --- | --- | --- -`methodName()` | None. | void | Lorem ipsum dolor. +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. ## NPM scripts