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

update readme file viewer

Browse Source
This commit is contained in:
Mario Romano
2016-06-01 11:46:46 +01:00
parent b1471fb7d9
commit cfdaec4e20
1 changed files with 25 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,25 +1,28 @@
# <ng2-alfresco-viewer> # Alfresco File Viewer Component for Angular 2
[![NPM version][npm-image]][npm-url] <p>
[![Build Status][travis-image]][travis-url] <a href='https://raw.githubusercontent.com/Alfresco/dev-platform-webcomponents/master/ng2-components/ng2-alfresco-viewer/LICENSE'>
[![Dependency Status][daviddm-image]][daviddm-url] <img src='https://img.shields.io/hexpm/l/plug.svg' alt='license' />
[![Coverage percentage][coveralls-image]][coveralls-url] </a>
[![Style guide][style-image]][style-url] <a href='https://www.alfresco.com/'>
[![Alfresco component][alfrescocomponent-image]][alfrescocomponent-url] <img src='https://img.shields.io/badge/style-component-green.svg?label=alfresco' alt='my blog' />
</a>
## About ng2-alfresco-viewer </p>
> Alfresco documents viewer
## Installation ## Install
```bash
```sh
npm set registry http://devproducts.alfresco.me:4873 npm set registry http://devproducts.alfresco.me:4873
npm install ng2-alfresco-viewer --save npm install --save ng2-alfresco-viewer
``` ```
#### Basic usage
```html ## Build from sources
<ng2-alfresco-viewer [urlFile]="'filename.pdf'"></ng2-alfresco-viewer> Alternatively you can build component from sources with the following commands:
```sh
npm install
npm run build
``` ```
#### Dependencies #### Dependencies
@@ -60,6 +63,12 @@ Make sure your systemjs.config has the following configuration:
}); });
``` ```
#### Basic usage
```html
<ng2-alfresco-viewer [urlFile]="'filename.pdf'"></ng2-alfresco-viewer>
```
#### Options #### Options
Attribute | Options | Default | Description Attribute | Options | Default | Description