From f62f60d5040b4b9333210b0cb08f69227b243b52 Mon Sep 17 00:00:00 2001 From: Rai Siqueira Date: Sun, 22 Nov 2020 18:37:53 -0300 Subject: [PATCH] docs(project): update readme. closes #78 Signed-off-by: Rai Siqueira --- README.md | 39 +++++++++++++++++++++++++++------------ 1 file changed, 27 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 502230b..ca11b54 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,39 @@ +

Justa Angular Library 🅰️

+ +

[![Build Status](https://travis-ci.com/justapagamentos/justa-angular-library.svg?branch=master)](https://travis-ci.com/justapagamentos/justa-angular-library) +

+ +> An collection of _Angular Modules_ and _libraries_ used in some applications of the Justa Payments. + +## Packages into this monorepo: + +| Package | Description | Version | NPM Link | Bundle size | Status | +| -------------- | ------------------------------------------------------------------ | ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------ | +| mask-directive | Collection of Angular directives to use with input elements | ![npm (scoped)](https://img.shields.io/npm/v/@justa/mask-directive?color=%23076e95) | [@justa/mask-directive](https://www.npmjs.com/package/@justa/mask-directive) | ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/@justa/mask-directive?color=%23076e95) | ✅ | +| ng-validators | Collection of Angular reactive forms validators | ![npm (scoped)](https://img.shields.io/npm/v/@justa/ng-validators?color=%23076e95) | [@justa/ng-validators](https://www.npmjs.com/package/@justa/ng-validators) | ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/@justa/ng-validators?color=%23076e95) | ✅ | +| jst-pagination | Angular component that create a pagination interface without drama | ![npm (scoped)](https://img.shields.io/npm/v/@justa/jst-pagination?color=%23076e95) | [@justa/jst-pagination](https://www.npmjs.com/package/@justa/jst-pagination) | ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/@justa/jst-pagination?color=%23076e95) | ⚠️ | -# Justa Angular Library +**Legends**: ✅ (Active) | ⚠️ (Deprecated) -An collection of _Angular Modules_ and _libraries_ used in some applications of the Justa Payments. +## Contributing -## Packages +Clone this repo and install dependencies with [Yarn](http://yarnpkg.org/), after that you can start to help-us to improve these libraries. -| Package | Version | NPM Link | Bundle size | -|---------|---------|-----| ----------------- | -| jst-pagination | ![npm (scoped)](https://img.shields.io/npm/v/@justa/jst-pagination?color=%23076e95) | [@justa/jst-pagination](https://www.npmjs.com/package/@justa/jst-pagination) | ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/@justa/jst-pagination?color=%23076e95) | -| mask-directive | ![npm (scoped)](https://img.shields.io/npm/v/@justa/mask-directive?color=%23076e95) | [@justa/mask-directive](https://www.npmjs.com/package/@justa/mask-directive) | ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/@justa/mask-directive?color=%23076e95) | -| ng-validators | ![npm (scoped)](https://img.shields.io/npm/v/@justa/ng-validators?color=%23076e95) | [@justa/ng-validators](https://www.npmjs.com/package/@justa/ng-validators) | ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/@justa/ng-validators?color=%23076e95) | -| utilities | ![npm (scoped)](https://img.shields.io/npm/v/@justa/utilities?color=%23076e95) | [@justa/utilities](https://www.npmjs.com/package/@justa/utilities) | ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/@justa/utilities?color=%23076e95) | +All libraries are in the projects/justa folder. Before coding make sure if you are changing the right project and files. -## Develop only +### Develop and build any package + +To see all changes across you development run these command to watch all changes: + +```bash +ng build @justa/PACKAGE_NAME --watch +``` -To run an project based on _project_ folder, run the this command: +And to build a package, you can run same command, but without the _watch_ flag: ```bash -ng build @justa/PROJECT_FOLDER --watch +ng build @justa/PACKAGE_NAME ``` ## License