packages/core/README.md
# NgxValidate
<p align="center">
<img src="https://github.com/ng-turkey/ngx-validate/workflows/Lint%20&%20Test%20&%20Build/badge.svg"/>
<a href="https://codeclimate.com/github/ng-turkey/ngx-validate/maintainability"><img src="https://api.codeclimate.com/v1/badges/1e3e683f0e67e72d7066/maintainability" /></a>
<a href="https://codeclimate.com/github/ng-turkey/ngx-validate/test_coverage"><img src="https://api.codeclimate.com/v1/badges/1e3e683f0e67e72d7066/test_coverage" /></a>
<img src="https://img.shields.io/github/license/ng-turkey/ngx-validate.svg" />
<a href="https://twitter.com/ngTurkiye"><img src="https://img.shields.io/twitter/follow/ngTurkiye.svg?label=Follow"/></a>
</p>
This project is still a work-in-progress and, although it works fine, it should be used with caution.
## Live demo
[Stackblitz Example](https://stackblitz.com/edit/ngx-validate)
## Installation
```bash
yarn add @ngx-validate/core
```
or
```bash
npm install @ngx-validate/core
```
## Usage
Import core module to your main module as follows:
```typescript
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { ReactiveFormsModule } from '@angular/forms';
import { AppRoutingModule } from './app-routing.module';
import { AppComponent } from './app.component';
import { NgxValidateCoreModule } from '@ngx-validate/core';
@NgModule({
declarations: [AppComponent],
imports: [BrowserModule, AppRoutingModule, ReactiveFormsModule, NgxValidateCoreModule.forRoot()],
providers: [],
bootstrap: [AppComponent],
})
export class AppModule {}
```
## Features
- [x] Dynamic display of validation errors
- [x] Support for error blueprints with parameters
- [x] Separate directives to mark style and render targets in DOM
- [x] Meaningful defaults, instant start
- [x] Flexible configuration on module, form group, and form control level
- [x] Permissive license (MIT)