From 314e5496e58b980ea7ff41b2147b9cee43d4483a Mon Sep 17 00:00:00 2001 From: Mario Romano Date: Thu, 1 Sep 2016 15:21:04 +0100 Subject: [PATCH] update readme --- ng2-components/ng2-activiti-form/README.md | 31 +++++++++ .../ng2-activiti-processlist/README.md | 63 ++++++++++++------- .../ng2-activiti-tasklist/README.md | 31 +++++++++ ng2-components/ng2-alfresco-core/README.md | 6 +- ng2-components/ng2-alfresco-login/README.md | 6 +- ng2-components/ng2-alfresco-search/README.md | 6 +- ng2-components/ng2-alfresco-upload/README.md | 6 +- ng2-components/ng2-alfresco-viewer/README.md | 6 +- .../ng2-alfresco-webscript/README.md | 6 +- 9 files changed, 126 insertions(+), 35 deletions(-) diff --git a/ng2-components/ng2-activiti-form/README.md b/ng2-components/ng2-activiti-form/README.md index e0ddb5af56..203a83f93b 100644 --- a/ng2-components/ng2-activiti-form/README.md +++ b/ng2-components/ng2-activiti-form/README.md @@ -1,4 +1,35 @@ # Alfresco Bpm Form component for Angular 2 +

+ + travis
+    Status + + + travis
+    Status + + + Coverage Status + + + npm downloads + + + license + + + alfresco component + + + angular 2 + + + typescript + + + node version + +

## Prerequisites diff --git a/ng2-components/ng2-activiti-processlist/README.md b/ng2-components/ng2-activiti-processlist/README.md index f4c967396b..26a3aa8ad6 100644 --- a/ng2-components/ng2-activiti-processlist/README.md +++ b/ng2-components/ng2-activiti-processlist/README.md @@ -1,11 +1,42 @@ -# <ng-2-activiti-processlist> -[![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] - +# Activiti Proess List Component for Angular 2 +

+ + travis
+    Status + + + travis
+    Status + + + Coverage Status + + + npm downloads + + + license + + + alfresco component + + + angular 2 + + + typescript + + + node version + +

+ + +## Prerequisites + +Before you start using this development framework, make sure you have installed all required software and done all the +necessary configuration, see this [page](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md). + ## About ng-2-activiti-processlist > Show available processes from the Activiti BPM suite @@ -84,18 +115,4 @@ For detailed changelog, check [Releases](https://github.com/Alfresco/ng-2-activi ## Contributors -[Contributors](https://github.com/Alfresco/ng-2-activiti-processlist/graphs/contributors) - - -[npm-image]: https://badge.fury.io/js/ng-2-activiti-processlist.svg -[npm-url]: https://npmjs.org/package/ng-2-activiti-processlist -[travis-image]: https://travis-ci.org/Alfresco/ng-2-activiti-processlist.svg?branch=master -[travis-url]: https://travis-ci.org/Alfresco/ng-2-activiti-processlist -[daviddm-image]: https://david-dm.org/Alfresco/ng-2-activiti-processlist.svg?theme=shields.io -[daviddm-url]: https://david-dm.org/Alfresco/ng-2-activiti-processlist -[coveralls-image]: https://coveralls.io/repos/Alfresco/ng-2-activiti-processlist/badge.svg -[coveralls-url]: https://coveralls.io/r/Alfresco/ng-2-activiti-processlist -[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 +[Contributors](https://github.com/Alfresco/ng-2-activiti-processlist/graphs/contributors) \ No newline at end of file diff --git a/ng2-components/ng2-activiti-tasklist/README.md b/ng2-components/ng2-activiti-tasklist/README.md index e6a5be262c..7f2fa63e0f 100644 --- a/ng2-components/ng2-activiti-tasklist/README.md +++ b/ng2-components/ng2-activiti-tasklist/README.md @@ -1,4 +1,35 @@ # Activiti Task List Component for Angular 2 +

+ + travis
+    Status + + + travis
+    Status + + + Coverage Status + + + npm downloads + + + license + + + alfresco component + + + angular 2 + + + typescript + + + node version + +

## Prerequisites diff --git a/ng2-components/ng2-alfresco-core/README.md b/ng2-components/ng2-alfresco-core/README.md index 078df01b91..2e5ece5e67 100644 --- a/ng2-components/ng2-alfresco-core/README.md +++ b/ng2-components/ng2-alfresco-core/README.md @@ -35,8 +35,10 @@ Core library for other ng2-alfresco components. This should be added as a dependency for any project using the components. -### Node -To correctly use this component check that on your machine is running Node version 5.0.0 or higher. +## Prerequisites + +Before you start using this development framework, make sure you have installed all required software and done all the +necessary configuration, see this [page](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md). ## Install diff --git a/ng2-components/ng2-alfresco-login/README.md b/ng2-components/ng2-alfresco-login/README.md index 681854ace8..b043701fef 100644 --- a/ng2-components/ng2-alfresco-login/README.md +++ b/ng2-components/ng2-alfresco-login/README.md @@ -31,8 +31,10 @@

-### Node -To correctly use this component check that on your machine is running Node version 5.0.0 or higher. +## Prerequisites + +Before you start using this development framework, make sure you have installed all required software and done all the +necessary configuration, see this [page](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md). ## Install diff --git a/ng2-components/ng2-alfresco-search/README.md b/ng2-components/ng2-alfresco-search/README.md index 76bc2575c2..f20963f4c3 100644 --- a/ng2-components/ng2-alfresco-search/README.md +++ b/ng2-components/ng2-alfresco-search/README.md @@ -32,8 +32,10 @@

-### Node -To correctly use this component check that on your machine is running Node version 5.0.0 or higher. +## Prerequisites + +Before you start using this development framework, make sure you have installed all required software and done all the +necessary configuration, see this [page](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md). ## Install diff --git a/ng2-components/ng2-alfresco-upload/README.md b/ng2-components/ng2-alfresco-upload/README.md index cf8538a4a6..7b8e3355be 100644 --- a/ng2-components/ng2-alfresco-upload/README.md +++ b/ng2-components/ng2-alfresco-upload/README.md @@ -31,8 +31,10 @@

-### Node -To correctly use this component check that on your machine is running Node version 5.0.0 or higher. +## Prerequisites + +Before you start using this development framework, make sure you have installed all required software and done all the +necessary configuration, see this [page](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md). ## Install diff --git a/ng2-components/ng2-alfresco-viewer/README.md b/ng2-components/ng2-alfresco-viewer/README.md index 3de759cc6b..57867e770c 100644 --- a/ng2-components/ng2-alfresco-viewer/README.md +++ b/ng2-components/ng2-alfresco-viewer/README.md @@ -31,8 +31,10 @@

-### Node -To correctly use this component check that on your machine is running Node version 5.0.0 or higher. +## Prerequisites + +Before you start using this development framework, make sure you have installed all required software and done all the +necessary configuration, see this [page](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md). ## Install diff --git a/ng2-components/ng2-alfresco-webscript/README.md b/ng2-components/ng2-alfresco-webscript/README.md index 398491efaa..cb0e181fe1 100644 --- a/ng2-components/ng2-alfresco-webscript/README.md +++ b/ng2-components/ng2-alfresco-webscript/README.md @@ -31,8 +31,10 @@

-### Node -To correctly use this component check that on your machine is running Node version 5.0.0 or higher. +## Prerequisites + +Before you start using this development framework, make sure you have installed all required software and done all the +necessary configuration, see this [page](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md). ## Install