'Readme.md' improvements

This commit is contained in:
Denys Vuika
2016-04-19 10:32:56 +01:00
parent 4a85b28f17
commit c90fac92a8
3 changed files with 44 additions and 2 deletions

View File

@@ -1,10 +1,13 @@
### Prerequisites
- [Alfresco Docker image with CORS support](https://github.com/wabson/alfresco-docker-cors)
### Start development
Install the npm packages described in the `package.json` and verify that it works:
```bash
$ npm install
$ bower install
$ npm start
```
You're ready to write your application.

39
ng2-alfresco/README.md Normal file
View File

@@ -0,0 +1,39 @@
# Alfresco Components for Angular 2
Components included:
* Document List Component
* Hello World component
* Alfresco Service
### Document List Component
```ts
export class MyView {
thumbnails: boolean = true;
breadcrumb: boolean = false;
navigation: boolean = true;
downloads: boolean = true;
events: any[] = [];
onItemClick($event) {
console.log($event.value);
this.events.push({
name: 'Item Clicked',
value: $event.value
});
}
}
```
```html
<alfresco-document-list
#list
[thumbnails]="thumbnails"
[breadcrumb]="breadcrumb"
[navigate]="navigation"
[downloads]="downloads"
(itemClick)="onItemClick($event)">
</alfresco-document-list>
```