diff --git a/README.md b/README.md index b56e33e007..72cb457517 100644 --- a/README.md +++ b/README.md @@ -1 +1 @@ -#ALFRESCO WEB COMPONENTS \ No newline at end of file +# ALFRESCO WEB COMPONENTS diff --git a/demo-shell-ng2/README.md b/demo-shell-ng2/README.md index 213f44d194..c3510b27ab 100644 --- a/demo-shell-ng2/README.md +++ b/demo-shell-ng2/README.md @@ -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. diff --git a/ng2-alfresco/README.md b/ng2-alfresco/README.md new file mode 100644 index 0000000000..1353b763f1 --- /dev/null +++ b/ng2-alfresco/README.md @@ -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 + + +```