readme(App) : updated readme

README.md

@@ -1,27 +1,78 @@
-# Fabric8AdminConsole
+# Admin Console
 
-This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 6.2.3.
+Admin Console is an application for admins to manage users on Codeready Toolchain.
 
-## Development server
+## 1. Prerequisites
 
-Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
+You need to install:
 
-## Code scaffolding
+* `Node` [Here](https://nodejs.org/en/)
+* `Git` [Here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
+* `Angular` (>= v6) [Here](https://angular.io/guide/quickstart#step-1-install-the-angular-cli)
 
-Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
+Run the following command to find out your Angular version.
 
-## Build
+```
+$ ng version
+```
 
-Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
+*You must at least have Angular version 6*.
 
-## Running unit tests
 
-Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
+#### 1.1 Check out the code
 
-## Running end-to-end tests
+```
+$ git clone https://github.com/fabric8-ui/fabric8-admin-console
+```
+#### 1.2 Installing Dependencipes
 
-Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
+To fetch the dependencies, generate code and finally build the project you can
+type `npm install` in a freshly clone repository of this project.
 
-## Further help
+```
+$ cd fabric8-admin-console
+$ npm install
+```
 
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
+#### 1.3 Build and Run
+
+
+Run `ng build` to build the project. The build artifacts will be stored in the dist/ directory. Use the `--prod` flag for a production build.
+
+Run `ng serve` to serve the project.
+
+## 2. Tests
+
+#### 2.1 Unit Tests
+
+Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io/latest/index.html).
+
+#### 2.2 End-To-End Test
+Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/#/).
+
+## 3. Contribution Guidelines
+#### 3.1 Code Quality
+fabric8-admin-console uses `tslint` to check the `typescript` code.It also uses `prettier` to check the format of `HTML`.
+
+##### Running the code quality checks
+Each linter is built into the build process, so running npm run build or npm start will display any errors, their location (file name and line number), and any error message(s). Whenever a file that is watched by the code quality checks is changed, the build (if started with npm start) will re-run, checking only the altered files.
+
+#### 3.2 Working on an issue
+One can work on the issues and can raise a pull request for the same.List of open [issues](https://github.com/fabric8-ui/fabric8-admin-console/issues).
+
+If it is a feature then, the title of the PR should be somewhat similar to [this](https://github.com/fabric8-ui/fabric8-admin-console/pull/23). 
+
+```
+feat(UX): Improve Functionality and Experience By Patternfly-ng 
+```
+
+If it's a fix that you were working with,then the title should be similar to [this](https://github.com/fabric8-ui/fabric8-admin-console/pull/48).
+```
+fix(tests): add unit tests for userService and userStore 
+```
+## 4. References
+* [Angular Docs](https://angular.io/)
+* [Patternfly-3](https://github.com/patternfly/patternfly)
+* [Patternfly-4](https://github.com/patternfly/patternfly-next)
+* [fabric8-UI](https://github.com/fabric8-ui)
+* [fabric8-services](https://github.com/fabric8-services)