Skip to content

Commit 3cc6919

Browse files
Merge pull request #129 from hisptz/develop
chore(README.md): updated the README.md
2 parents afd3b79 + 8337ac4 commit 3cc6919

File tree

4 files changed

+77
-30
lines changed

4 files changed

+77
-30
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,26 @@ After installation you can use the following tags to start using it in your proj
8787
(close)="onUpdateValidationRule($event)">
8888
<lib-ngx-dhis2-validation-rule-filter>
8989

90-
90+
### Output Emmitted
91+
#### Template of the OUTPUT Emmitted after clicking the UPDATE or CANCEL button:
92+
items: []
93+
periodTypes: []
94+
dimensions: "vrg"
95+
change: true
96+
97+
#### Example of the output Emmitted after clicking the UPDATE or CANCEL button:
98+
99+
items: [
100+
{
101+
id: "odiGzVETtQQ",
102+
name: "Form: National Malaria control program"
103+
}
104+
]
105+
periodTypes: [
106+
"Monthly"
107+
]
108+
dimensions: "vrg"
109+
change: true
91110

92111

93112
## Contributions

package-lock.json

Lines changed: 12 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
"ang-jsoneditor": "^1.8.0",
3434
"bootstrap": "^4.3.1",
3535
"commitizen": "^3.1.1",
36-
"core-js": "^3.1.4",
36+
"core-js": "^2.5.7",
3737
"docdash": "^1.1.0",
3838
"jsoneditor": "^6.1.0",
3939
"lodash": "^4.17.14",
@@ -73,7 +73,7 @@
7373
"tsickle": ">=0.36.0",
7474
"tslib": "^1.10.0",
7575
"tslint": "~5.18.0",
76-
"typescript": "~3.4.5"
76+
"typescript": "^3.2.4"
7777
},
7878
"config": {
7979
"commitizen": {

projects/ngx-dhis2-validation-rule-filter/README.md

Lines changed: 43 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
11
# Dhis2 Validation Rule Group Filter Library
2-
[![CircleCI](https://circleci.com/gh/interactive-apps/ngx-dhis2-validation-rule-filter.svg?style=svg)](https://circleci.com/gh/interactive-apps/ngx-dhis2-validation-rule-filter)
3-
[![Build Status](https://travis-ci.org/interactive-apps/ngx-dhis2-validation-rule-filter.svg?branch=master)](https://travis-ci.org/interactive-apps/ngx-dhis2-validation-rule-filter)
4-
[![Maintainability](https://api.codeclimate.com/v1/badges/a99a88d28ad37a79dbf6/maintainability)](https://codeclimate.com/github/interactive-apps/ngx-dhis2-validation-rule-filter/maintainability)
5-
[![Test Coverage](https://api.codeclimate.com/v1/badges/a99a88d28ad37a79dbf6/test_coverage)](https://codeclimate.com/github/interactive-apps/ngx-dhis2-validation-rule-filter/test_coverage)
2+
[![CircleCI](https://circleci.com/gh/hisptz/ngx-dhis2-validation-rule-filter.svg?style=svg)](https://circleci.com/gh/hisptz/ngx-dhis2-validation-rule-filter)
3+
[![Build Status](https://travis-ci.org/hisptz/ngx-dhis2-validation-rule-filter.svg?branch=master)](https://travis-ci.org/hisptz/ngx-dhis2-validation-rule-filter)
4+
[![Maintainability](https://api.codeclimate.com/v1/badges/a99a88d28ad37a79dbf6/maintainability)](https://codeclimate.com/github/hisptz/ngx-dhis2-validation-rule-filter/maintainability)
5+
[![Test Coverage](https://api.codeclimate.com/v1/badges/a99a88d28ad37a79dbf6/test_coverage)](https://codeclimate.com/github/hisptz/ngx-dhis2-validation-rule-filter/test_coverage)
66
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
7-
[![Gitter chat](https://badges.gitter.im/interactive-apps/gitter.png)](https://gitter.im/interactive-apps/community)
8-
![GitHub](https://img.shields.io/github/license/interactive-apps/ngx-dhis2-validation-rule-filter.svg)
7+
[![Gitter chat](https://badges.gitter.im/hisptz/gitter.png)](https://gitter.im/hisptz/community)
8+
![GitHub](https://img.shields.io/github/license/hisptz/ngx-dhis2-validation-rule-filter.svg)
99
[![commitizen on stackoverflow](https://img.shields.io/badge/stackoverflow-community-orange.svg?longCache=true&style=flat-square&logo=stackoverflow)](https://stackoverflow.com/tags/dhis-2)
1010
![npm](https://img.shields.io/npm/v/@iapps/ngx-dhis2-validation-rule-group-filter.svg)
11-
![GitHub All Releases](https://img.shields.io/github/downloads/interactive-apps/ngx-dhis2-validation-rule-filter/total.svg)
12-
![GitHub issues](https://img.shields.io/github/issues/interactive-apps/ngx-dhis2-validation-rule-filter.svg)
13-
![GitHub closed issues](https://img.shields.io/github/issues-closed/interactive-apps/ngx-dhis2-validation-rule-filter.svg)
14-
![GitHub package.json version](https://img.shields.io/github/package-json/v/interactive-apps/ngx-dhis2-validation-rule-filter.svg)
15-
16-
11+
![GitHub All Releases](https://img.shields.io/github/downloads/hisptz/ngx-dhis2-validation-rule-filter/total.svg)
12+
![GitHub issues](https://img.shields.io/github/issues/hisptz/ngx-dhis2-validation-rule-filter.svg)
13+
![GitHub closed issues](https://img.shields.io/github/issues-closed/hisptz/ngx-dhis2-validation-rule-filter.svg)
14+
![GitHub package.json version](https://img.shields.io/github/package-json/v/hisptz/ngx-dhis2-validation-rule-filter.svg)
1715
## Introduction
16+
1817
Dhis2 Validation Rule Group(DVRG) is a user interface component library for developing [DHIS2](http://www.dhis2.org/) applications. DHIS2 Team from UDSM uses and maintain this component to ensure visual and usability consistency where it is used in the process of developing different DHIS2 web application.
1918

2019
## Features
@@ -28,13 +27,13 @@ Dhis2 Validation Rule Group(DVRG) is a user interface component library for deve
2827
### Prerequisite Requirements
2928
Install the following dependencies withing your project before starting using the following library.
3029

31-
- NgRx Store v7.4.0 or Higher- [@ngrx/store](https://www.npmjs.com/package/@ngrx/store)
32-
- NgRx Effects v7.4.0 or Higher- [@ngrx/effects](https://www.npmjs.com/package/@ngrx/effects)
33-
- RxJS: Reactive Extensions For JavaScript v6.5.2 or Higher - [rxjs](https://www.npmjs.com/package/rxjs)
34-
- lodash v4.17.11
30+
- NgRx Store v7.4.0 or Higher- [@ngrx/store](https://www.npmjs.com/package/@ngrx/store)
31+
- NgRx Effects v7.4.0 or Higher- [@ngrx/effects](https://www.npmjs.com/package/@ngrx/effects)
32+
- RxJS: Reactive Extensions For JavaScript v6.5.2 or Higher - [rxjs](https://www.npmjs.com/package/rxjs)
33+
- lodash v4.17.11
3534
or Higher- [lodash v4.17.11
3635
](https://www.npmjs.com/package/lodash)
37-
- DHIS2 Http Client library
36+
- DHIS2 Http Client library
3837
v2.0.2 or Higher - [@hisptz/ngx-dhis2-http-client](https://www.npmjs.com/package/@ngrx/effects)
3938
- Dhis2 Validation Rule Group Filter Library
4039
v1.0.0-alpha.6 or Higher - [@iapps/ngx-dhis2-validation-rule-group-filter
@@ -88,10 +87,33 @@ After installation you can use the following tags to start using it in your proj
8887
(close)="onUpdateValidationRule($event)">
8988
<lib-ngx-dhis2-validation-rule-filter>
9089

91-
## Versioning
92-
> Current version of this build of **Dhis2 Validation Rule Group Filter Library**
90+
### Output Emmitted
91+
#### Template of the OUTPUT Emmitted after clicking the UPDATE or CANCEL button:
92+
items: []
93+
periodTypes: []
94+
dimensions: "vrg"
95+
change: true
96+
97+
#### Example of the output Emmitted after clicking the UPDATE or CANCEL button:
98+
99+
items: [
100+
{
101+
id: "odiGzVETtQQ",
102+
name: "Form: National Malaria control program"
103+
}
104+
]
105+
periodTypes: [
106+
"Monthly"
107+
]
108+
dimensions: "vrg"
109+
change: true
93110

94-
![GitHub package.json version](https://img.shields.io/github/package-json/v/interactive-apps/ngx-dhis2-validation-rule-filter.svg)
111+
112+
## Contributions
113+
[![](https://sourcerer.io/fame/waltervfaustine/interactive-apps/ngx-dhis2-validation-rule-filter/images/0)](https://sourcerer.io/fame/waltervfaustine/interactive-apps/ngx-dhis2-validation-rule-filter/links/0)[![](https://sourcerer.io/fame/waltervfaustine/interactive-apps/ngx-dhis2-validation-rule-filter/images/1)](https://sourcerer.io/fame/waltervfaustine/interactive-apps/ngx-dhis2-validation-rule-filter/links/1)[![](https://sourcerer.io/fame/waltervfaustine/interactive-apps/ngx-dhis2-validation-rule-filter/images/2)](https://sourcerer.io/fame/waltervfaustine/interactive-apps/ngx-dhis2-validation-rule-filter/links/2)[![](https://sourcerer.io/fame/waltervfaustine/interactive-apps/ngx-dhis2-validation-rule-filter/images/3)](https://sourcerer.io/fame/waltervfaustine/interactive-apps/ngx-dhis2-validation-rule-filter/links/3)[![](https://sourcerer.io/fame/waltervfaustine/interactive-apps/ngx-dhis2-validation-rule-filter/images/4)](https://sourcerer.io/fame/waltervfaustine/interactive-apps/ngx-dhis2-validation-rule-filter/links/4)[![](https://sourcerer.io/fame/waltervfaustine/interactive-apps/ngx-dhis2-validation-rule-filter/images/5)](https://sourcerer.io/fame/waltervfaustine/interactive-apps/ngx-dhis2-validation-rule-filter/links/5)[![](https://sourcerer.io/fame/waltervfaustine/interactive-apps/ngx-dhis2-validation-rule-filter/images/6)](https://sourcerer.io/fame/waltervfaustine/interactive-apps/ngx-dhis2-validation-rule-filter/links/6)[![](https://sourcerer.io/fame/waltervfaustine/interactive-apps/ngx-dhis2-validation-rule-filter/images/7)](https://sourcerer.io/fame/waltervfaustine/hisptz/ngx-dhis2-validation-rule-filter/links/7)
95114

96115
## Licence
97-
![GitHub](https://img.shields.io/github/license/interactive-apps/ngx-dhis2-validation-rule-filter.svg)
116+
![GitHub](https://img.shields.io/github/license/hisptz/ngx-dhis2-validation-rule-filter.svg?style=for-the-badge)
117+
118+
119+

0 commit comments

Comments
 (0)