mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-31 17:38:48 +00:00
Start adding ecmUser component
This commit is contained in:
43
ng2-components/ng2-alfresco-userinfo/README.md
Normal file
43
ng2-components/ng2-alfresco-userinfo/README.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# ng2-alfresco-userinfo
|
||||
This component will show the user information for ECM and BPM
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install ng2-alfresco-userinfo --save
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
```html
|
||||
<ng2-alfresco-userinfo></ng2-alfresco-userinfo>
|
||||
```
|
||||
|
||||
## Reference
|
||||
|
||||
Attribute | Options | Default | Description
|
||||
--- | --- | --- | ---
|
||||
`foo` | *string* | `bar` | Lorem ipsum dolor.
|
||||
|
||||
|
||||
Method | Parameters | Returns | Description
|
||||
--- | --- | --- | ---
|
||||
`methodName()` | None. | void | Lorem ipsum dolor.
|
||||
|
||||
## NPM scripts
|
||||
|
||||
| Command | Description |
|
||||
| --- | --- |
|
||||
| npm run build | Build component |
|
||||
| npm run build:w | Build component and keep watching the changes |
|
||||
| npm run test | Run unit tests in the console |
|
||||
| npm run test-browser | Run unit tests in the browser
|
||||
| npm run coverage | Run unit tests and display code coverage report |
|
||||
|
||||
## History
|
||||
|
||||
For detailed changelog, check [Releases](https://github.com/alfresco/ng2-alfresco-userinfo/releases).
|
||||
|
||||
## Contributors
|
||||
|
||||
[Contributors](https://github.com/alfresco/ng2-alfresco-userinfo/graphs/contributors)
|
Reference in New Issue
Block a user