first commit document viewer scaffold

ng2-components/ng2-alfresco-viewer/README.md

@@ -0,0 +1,81 @@
+# <ng-2-alfresco-viewer>
+[![NPM version][npm-image]][npm-url] 
+[![Build Status][travis-image]][travis-url] 
+[![Dependency Status][daviddm-image]][daviddm-url]
+[![Coverage percentage][coveralls-image]][coveralls-url]
+[![Style guide][style-image]][style-url]          
+[![Alfresco component][alfrescocomponent-image]][alfrescocomponent-url]          
+                  
+## About ng-2-alfresco-viewer
+> Alfresco documents viewer
+
+## Installation
+
+```bash
+npm install ng-2-alfresco-viewer --save
+```
+
+## Example
+
+```html
+<ng-2-alfresco-viewer></ng-2-alfresco-viewer>
+```
+
+## Reference
+
+Attribute     | Options     | Default      | Description
+---           | ---         | ---          | ---
+`foo`         | *string*    | `bar`        | Lorem ipsum dolor.
+
+
+Method        | Parameters   | Returns     | Description
+---           | ---          | ---         | ---
+`methodName()`   | None.        | void    | Lorem ipsum dolor.
+
+## Develop command list 
+
+* To test your project
+
+    ```sh
+    $ npm run test
+    ```
+
+* To run the test coverage
+
+    ```sh
+    $ npm run coverage
+    ```
+
+* To build the distribution files before releasing a new version.
+
+    ```sh
+    $ npm run start
+    ```
+
+* To provide a live demo
+
+    ```sh
+    $ npm run deploy
+    ```
+
+## History
+
+For detailed changelog, check [Releases](https://github.com/alfresco/ng-2-alfresco-viewer/releases).
+
+## Contributors
+
+[Contributors](https://github.com/alfresco/ng-2-alfresco-viewer/graphs/contributors)
+
+
+[npm-image]: https://badge.fury.io/js/ng-2-alfresco-viewer.svg
+[npm-url]: https://npmjs.org/package/ng-2-alfresco-viewer
+[travis-image]: https://travis-ci.org/alfresco/ng-2-alfresco-viewer.svg?branch=master
+[travis-url]: https://travis-ci.org/alfresco/ng-2-alfresco-viewer
+[daviddm-image]: https://david-dm.org/alfresco/ng-2-alfresco-viewer.svg?theme=shields.io
+[daviddm-url]: https://david-dm.org/alfresco/ng-2-alfresco-viewer
+[coveralls-image]: https://coveralls.io/repos/alfresco/ng-2-alfresco-viewer/badge.svg
+[coveralls-url]: https://coveralls.io/r/alfresco/ng-2-alfresco-viewer
+[style-url]: https://github.com/mgechev/angular2-style-guide
+[style-image]: https://mgechev.github.io/angular2-style-guide/images/badge.svg
+[alfrescocomponent-image]: https://img.shields.io/badge/Alfresco%20component-approved-green.svg
+[alfrescocomponent-url]: https://www.alfresco.com