diff --git a/ng2-components/ng2-activiti-form/README.md b/ng2-components/ng2-activiti-form/README.md index 6fb4a5fa34..9507d66584 100644 --- a/ng2-components/ng2-activiti-form/README.md +++ b/ng2-components/ng2-activiti-form/README.md @@ -1,4 +1,4 @@ -# Alfresco Login Component for Angular 2 +# Activiti Form Component for Angular 2

travis
diff --git a/ng2-components/ng2-alfresco-core/README.md b/ng2-components/ng2-alfresco-core/README.md
index a828f4c977..de14e82d01 100644
--- a/ng2-components/ng2-alfresco-core/README.md
+++ b/ng2-components/ng2-alfresco-core/README.md
@@ -1,5 +1,4 @@
-# Alfresco Angular 2 Components core
-
+# Alfresco Login Component for Angular 2
 <p>
   <a title= travis
@@ -15,11 +14,23 @@
   <a href= npm downloads + + license + + + alfresco component + + + angular 2 + + + typescript + + + node version +

-Core library for other ng2-alfresco components. -This should be added as a dependency for any project using the components. - ## Prerequisites Before you start using this development framework, make sure you have installed all required software and done all the @@ -198,10 +209,43 @@ npm install npm run build ``` -### Additional scripts +## Build from sources -- `npm run build:w` builds the files and keep watching for changes -- `npm test` runs unit tests -- `npm run test-browser` runs unit tests in browser. This task rebuilds all the code, runs tslint, license checks and other quality check tools +Alternatively you can build component from sources with the following commands: + + +```sh +npm install +npm run build +``` + +### Build the files and keep watching for changes + +```sh +$ npm run build:w +``` + +## Running unit tests + +```sh +npm test +``` + +### Running unit tests in browser + +```sh +npm test-browser +``` + +This task rebuilds all the code, runs tslint, license checks and other quality check tools before performing unit testing. -- `npm run coverage` runs code coverage report + +### Code coverage + +```sh +npm run coverage +``` + +## License + +[Apache Version 2.0](https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE) \ No newline at end of file diff --git a/ng2-components/ng2-alfresco-login/README.md b/ng2-components/ng2-alfresco-login/README.md index 21fd802154..57924643d3 100644 --- a/ng2-components/ng2-alfresco-login/README.md +++ b/ng2-components/ng2-alfresco-login/README.md @@ -1,4 +1,4 @@ -# Alfresco Login Component for Angular 2 +# Alfresco Core Component for Angular 2