inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-31 17:38:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

#279 update doc

Browse Source
This commit is contained in:
Mario Romano
2016-06-27 12:20:27 +01:00
parent b293183362
commit e509dfceb1
9 changed files with 31 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -59,8 +59,8 @@ npm publish
```sh ```sh
git clone https://github.com/Alfresco/dev-platform-js-api.git git clone https://github.com/Alfresco/dev-platform-js-api.git
git clone https://github.com/Alfresco/dev-platform-webcomponents.git git clone https://github.com/Alfresco/app-dev-framework.git
cd dev-platform-webcomponents cd app-dev-framework
``` ```
* Start the demo and Install all the dependencies (do it the first time) * Start the demo and Install all the dependencies (do it the first time)

4
ng2-components/README.md
View File

@@ -1,6 +1,6 @@
# Alfresco Angular 2 Components # Alfresco Angular 2 Components
<a title='Build Status' href="https://travis-ci.com/Alfresco/dev-platform-webcomponents"> <a title='Build Status' href="https://travis-ci.com/Alfresco/app-dev-framework">
<img src='https://travis-ci.com/Alfresco/dev-platform-webcomponents.svg?token=FPzV2wyyCU8imY6wHR2B&branch=master' alt='travis Status' /> <img src='https://travis-ci.com/Alfresco/app-dev-framework.svg?token=FPzV2wyyCU8imY6wHR2B&branch=master' alt='travis Status' />
</a> </a>
- [Core library](ng2-alfresco-core/README.md) - [Core library](ng2-alfresco-core/README.md)

6
ng2-components/ng2-alfresco-core/README.md
View File

@@ -1,7 +1,7 @@
# Alfresco Angular2 Components core # Alfresco Angular2 Components core
<p> <p>
<a href='https://raw.githubusercontent.com/Alfresco/dev-platform-webcomponents/master/ng2-components/ng2-alfresco-upload/LICENSE'> <a href='https://raw.githubusercontent.com/Alfresco/app-dev-framework/master/ng2-components/ng2-alfresco-upload/LICENSE'>
<img src='https://img.shields.io/hexpm/l/plug.svg' alt='license' /> <img src='https://img.shields.io/hexpm/l/plug.svg' alt='license' />
</a> </a>
<a href='https://www.alfresco.com/'> <a href='https://www.alfresco.com/'>
@@ -10,8 +10,8 @@
<a href='https://www.alfresco.com/'> <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' /> <img src='https://img.shields.io/badge/style-%3E5.0.0-blue.svg?label=node%20version' alt='node version' />
</a> </a>
<a title='Build Status' href="https://travis-ci.com/Alfresco/dev-platform-webcomponents"> <a title='Build Status' href="https://travis-ci.com/Alfresco/app-dev-framework">
<img src='https://travis-ci.com/Alfresco/dev-platform-webcomponents.svg?token=FPzV2wyyCU8imY6wHR2B&branch=master' alt='travis Status' /> <img src='https://travis-ci.com/Alfresco/app-dev-framework.svg?token=FPzV2wyyCU8imY6wHR2B&branch=master' alt='travis Status' />
</a> </a>
</p> </p>

6
ng2-components/ng2-alfresco-datatable/README.md
View File

@@ -1,7 +1,7 @@
# DataTable Component for Angular 2 # DataTable Component for Angular 2
<p> <p>
<a href='https://raw.githubusercontent.com/Alfresco/dev-platform-webcomponents/master/ng2-components/ng2-alfresco-upload/LICENSE'> <a href='https://raw.githubusercontent.com/Alfresco/app-dev-framework/master/ng2-components/ng2-alfresco-upload/LICENSE'>
<img src='https://img.shields.io/hexpm/l/plug.svg' alt='license' /> <img src='https://img.shields.io/hexpm/l/plug.svg' alt='license' />
</a> </a>
<a href='https://www.alfresco.com/'> <a href='https://www.alfresco.com/'>
@@ -10,8 +10,8 @@
<a href='https://www.alfresco.com/'> <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' /> <img src='https://img.shields.io/badge/style-%3E5.0.0-blue.svg?label=node%20version' alt='node version' />
</a> </a>
<a title='Build Status' href="https://travis-ci.com/Alfresco/dev-platform-webcomponents"> <a title='Build Status' href="https://travis-ci.com/Alfresco/app-dev-framework">
<img src='https://travis-ci.com/Alfresco/dev-platform-webcomponents.svg?token=FPzV2wyyCU8imY6wHR2B&branch=master' alt='travis Status' /> <img src='https://travis-ci.com/Alfresco/app-dev-framework.svg?token=FPzV2wyyCU8imY6wHR2B&branch=master' alt='travis Status' />
</a> </a>
</p> </p>

8
ng2-components/ng2-alfresco-documentlist/README.md
View File

@@ -1,7 +1,7 @@
# Document List Component for Angular 2 # Document List Component for Angular 2
<p> <p>
<a href='https://raw.githubusercontent.com/Alfresco/dev-platform-webcomponents/master/ng2-components/ng2-alfresco-upload/LICENSE'> <a href='https://raw.githubusercontent.com/Alfresco/app-dev-framework/master/ng2-components/ng2-alfresco-upload/LICENSE'>
<img src='https://img.shields.io/hexpm/l/plug.svg' alt='license' /> <img src='https://img.shields.io/hexpm/l/plug.svg' alt='license' />
</a> </a>
<a href='https://www.alfresco.com/'> <a href='https://www.alfresco.com/'>
@@ -10,8 +10,8 @@
<a href='https://www.alfresco.com/'> <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' /> <img src='https://img.shields.io/badge/style-%3E5.0.0-blue.svg?label=node%20version' alt='node version' />
</a> </a>
<a title='Build Status' href="https://travis-ci.com/Alfresco/dev-platform-webcomponents"> <a title='Build Status' href="https://travis-ci.com/Alfresco/app-dev-framework">
<img src='https://travis-ci.com/Alfresco/dev-platform-webcomponents.svg?token=FPzV2wyyCU8imY6wHR2B&branch=master' alt='travis Status' /> <img src='https://travis-ci.com/Alfresco/app-dev-framework.svg?token=FPzV2wyyCU8imY6wHR2B&branch=master' alt='travis Status' />
</a> </a>
</p> </p>
@@ -41,7 +41,7 @@ The following component needs to be added to your systemjs.config:
Please refer to the following example to have an idea of how your systemjs.config should look like : Please refer to the following example to have an idea of how your systemjs.config should look like :
https://github.com/Alfresco/dev-platform-webcomponents/blob/master/ng2-components/ng2-alfresco-documentlist/demo/systemjs.config.js https://github.com/Alfresco/app-dev-framework/blob/master/ng2-components/ng2-alfresco-documentlist/demo/systemjs.config.js
#### Style #### Style
The style of this component is based on material design, so if you want to visualize it correctly you have to add the material The style of this component is based on material design, so if you want to visualize it correctly you have to add the material

8
ng2-components/ng2-alfresco-login/README.md
View File

@@ -1,6 +1,6 @@
# Alfresco Login Component for Angular 2 # Alfresco Login Component for Angular 2
<p> <p>
<a href='https://raw.githubusercontent.com/Alfresco/dev-platform-webcomponents/master/ng2-components/ng2-alfresco-upload/LICENSE'> <a href='https://raw.githubusercontent.com/Alfresco/app-dev-framework/master/ng2-components/ng2-alfresco-upload/LICENSE'>
<img src='https://img.shields.io/hexpm/l/plug.svg' alt='license' /> <img src='https://img.shields.io/hexpm/l/plug.svg' alt='license' />
</a> </a>
<a href='https://www.alfresco.com/'> <a href='https://www.alfresco.com/'>
@@ -9,8 +9,8 @@
<a href='https://www.alfresco.com/'> <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' /> <img src='https://img.shields.io/badge/style-%3E5.0.0-blue.svg?label=node%20version' alt='node version' />
</a> </a>
<a title='Build Status' href="https://travis-ci.com/Alfresco/dev-platform-webcomponents"> <a title='Build Status' href="https://travis-ci.com/Alfresco/app-dev-framework">
<img src='https://travis-ci.com/Alfresco/dev-platform-webcomponents.svg?token=FPzV2wyyCU8imY6wHR2B&branch=master' alt='travis Status' /> <img src='https://travis-ci.com/Alfresco/app-dev-framework.svg?token=FPzV2wyyCU8imY6wHR2B&branch=master' alt='travis Status' />
</a> </a>
</p> </p>
@@ -45,7 +45,7 @@ The following component needs to be added to your systemjs.config:
Please refer to the following example to have an idea of how your systemjs.config should look like : Please refer to the following example to have an idea of how your systemjs.config should look like :
https://github.com/Alfresco/dev-platform-webcomponents/blob/master/ng2-components/ng2-alfresco-login/demo/systemjs.config.js https://github.com/Alfresco/app-dev-framework/blob/master/ng2-components/ng2-alfresco-login/demo/systemjs.config.js
#### Style #### Style
The style of this component is based on material design, so if you want to visualize it correctly you have to add the material The style of this component is based on material design, so if you want to visualize it correctly you have to add the material

10
ng2-components/ng2-alfresco-search/README.md
View File

@@ -1,7 +1,7 @@
# Search Component for Angular 2 # Search Component for Angular 2
<p> <p>
<a href='https://raw.githubusercontent.com/Alfresco/dev-platform-webcomponents/master/ng2-components/ng2-alfresco-search/LICENSE'> <a href='https://raw.githubusercontent.com/Alfresco/app-dev-framework/master/ng2-components/ng2-alfresco-search/LICENSE'>
<img src='https://img.shields.io/hexpm/l/plug.svg' alt='license' /> <img src='https://img.shields.io/hexpm/l/plug.svg' alt='license' />
</a> </a>
<a href='https://www.alfresco.com/'> <a href='https://www.alfresco.com/'>
@@ -10,8 +10,8 @@
<a href='https://www.alfresco.com/'> <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' /> <img src='https://img.shields.io/badge/style-%3E5.0.0-blue.svg?label=node%20version' alt='node version' />
</a> </a>
<a title='Build Status' href="https://travis-ci.com/Alfresco/dev-platform-webcomponents"> <a title='Build Status' href="https://travis-ci.com/Alfresco/app-dev-framework">
<img src='https://travis-ci.com/Alfresco/dev-platform-webcomponents.svg?token=FPzV2wyyCU8imY6wHR2B&branch=master' alt='travis Status' /> <img src='https://travis-ci.com/Alfresco/app-dev-framework.svg?token=FPzV2wyyCU8imY6wHR2B&branch=master' alt='travis Status' />
</a> </a>
</p> </p>
@@ -51,7 +51,7 @@ The following component needs to be added to your systemjs.config:
Please refer to the following example to have an idea of how your systemjs.config should look like : Please refer to the following example to have an idea of how your systemjs.config should look like :
https://github.com/Alfresco/dev-platform-webcomponents/blob/master/ng2-components/ng2-alfresco-search/demo/systemjs.config.js https://github.com/Alfresco/app-dev-framework/blob/master/ng2-components/ng2-alfresco-search/demo/systemjs.config.js
#### Style #### Style
The style of this component is based on material design, so if you want to visualize it correctly you have to add the material The style of this component is based on material design, so if you want to visualize it correctly you have to add the material
@@ -178,7 +178,7 @@ The following component needs to be added to your systemjs.config:
Please refer to the following example to have an idea of how your systemjs.config should look like : Please refer to the following example to have an idea of how your systemjs.config should look like :
https://github.com/Alfresco/dev-platform-webcomponents/blob/master/ng2-components/ng2-alfresco-search/demo/systemjs.config.js https://github.com/Alfresco/app-dev-framework/blob/master/ng2-components/ng2-alfresco-search/demo/systemjs.config.js
#### Style #### Style
The style of this component is based on material design, so if you want to visualize it correctly you have to add the material The style of this component is based on material design, so if you want to visualize it correctly you have to add the material

8
ng2-components/ng2-alfresco-upload/README.md
View File

@@ -1,6 +1,6 @@
# Alfresco Upload Component for Angular 2 # Alfresco Upload Component for Angular 2
<p> <p>
<a href='https://raw.githubusercontent.com/Alfresco/dev-platform-webcomponents/master/ng2-components/ng2-alfresco-upload/LICENSE'> <a href='https://raw.githubusercontent.com/Alfresco/app-dev-framework/master/ng2-components/ng2-alfresco-upload/LICENSE'>
<img src='https://img.shields.io/hexpm/l/plug.svg' alt='license' /> <img src='https://img.shields.io/hexpm/l/plug.svg' alt='license' />
</a> </a>
<a href='https://www.alfresco.com/'> <a href='https://www.alfresco.com/'>
@@ -9,8 +9,8 @@
<a href='https://www.alfresco.com/'> <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' /> <img src='https://img.shields.io/badge/style-%3E5.0.0-blue.svg?label=node%20version' alt='node version' />
</a> </a>
<a title='Build Status' href="https://travis-ci.com/Alfresco/dev-platform-webcomponents"> <a title='Build Status' href="https://travis-ci.com/Alfresco/app-dev-framework">
<img src='https://travis-ci.com/Alfresco/dev-platform-webcomponents.svg?token=FPzV2wyyCU8imY6wHR2B&branch=master' alt='travis Status' /> <img src='https://travis-ci.com/Alfresco/app-dev-framework.svg?token=FPzV2wyyCU8imY6wHR2B&branch=master' alt='travis Status' />
</a> </a>
</p> </p>
@@ -48,7 +48,7 @@ The following component needs to be added to your systemjs.config:
Please refer to the following example to have an idea of how your systemjs.config should look like : Please refer to the following example to have an idea of how your systemjs.config should look like :
https://github.com/Alfresco/dev-platform-webcomponents/blob/master/ng2-components/ng2-alfresco-upload/demo/systemjs.config.js https://github.com/Alfresco/app-dev-framework/blob/master/ng2-components/ng2-alfresco-upload/demo/systemjs.config.js
#### Style #### Style
The style of this component is based on material design, so if you want to visualize it correctly you have to add the material The style of this component is based on material design, so if you want to visualize it correctly you have to add the material

8
ng2-components/ng2-alfresco-viewer/README.md
View File

@@ -1,6 +1,6 @@
# Alfresco File Viewer Component for Angular 2 # Alfresco File Viewer Component for Angular 2
<p> <p>
<a href='https://raw.githubusercontent.com/Alfresco/dev-platform-webcomponents/master/ng2-components/ng2-alfresco-viewer/LICENSE'> <a href='https://raw.githubusercontent.com/Alfresco/app-dev-framework/master/ng2-components/ng2-alfresco-viewer/LICENSE'>
<img src='https://img.shields.io/hexpm/l/plug.svg' alt='license' /> <img src='https://img.shields.io/hexpm/l/plug.svg' alt='license' />
</a> </a>
<a href='https://www.alfresco.com/'> <a href='https://www.alfresco.com/'>
@@ -9,8 +9,8 @@
<a href='https://www.alfresco.com/'> <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' /> <img src='https://img.shields.io/badge/style-%3E5.0.0-blue.svg?label=node%20version' alt='node version' />
</a> </a>
<a title='Build Status' href="https://travis-ci.com/Alfresco/dev-platform-webcomponents"> <a title='Build Status' href="https://travis-ci.com/Alfresco/app-dev-framework">
<img src='https://travis-ci.com/Alfresco/dev-platform-webcomponents.svg?token=FPzV2wyyCU8imY6wHR2B&branch=master' alt='travis Status' /> <img src='https://travis-ci.com/Alfresco/app-dev-framework.svg?token=FPzV2wyyCU8imY6wHR2B&branch=master' alt='travis Status' />
</a> </a>
</p> </p>
@@ -36,7 +36,7 @@ Add the following dependency to your index.html:
Make sure your systemjs.config has the following configuration: Make sure your systemjs.config has the following configuration:
https://github.com/Alfresco/dev-platform-webcomponents/blob/master/ng2-components/ng2-alfresco-viewer/demo/systemjs.config.js https://github.com/Alfresco/app-dev-framework/blob/master/ng2-components/ng2-alfresco-viewer/demo/systemjs.config.js
#### Style #### Style
The style of this component is based on material design, so if you want to visualize it correctly you have to add the material The style of this component is based on material design, so if you want to visualize it correctly you have to add the material