ngx-nz-formly 0.0.4 → 0.0.5

package/README.md

@@ -2,23 +2,34 @@
 
 This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 16.2.0.
 
-## Code scaffolding
-
-Run `ng generate component component-name --project NgxNzFormly` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project NgxNzFormly`.
-> Note: Don't forget to add `--project NgxNzFormly` or else it will be added to the default project in your `angular.json` file. 
-
-## Build
-
-Run `ng build NgxNzFormly` to build the project. The build artifacts will be stored in the `dist/` directory.
-
-## Publishing
-
-After building your library with `ng build NgxNzFormly`, go to the dist folder `cd dist/ngx-nz-formly` and run `npm publish`.
-
-## Running unit tests
-
-Run `ng test NgxNzFormly` to execute the unit tests via [Karma](https://karma-runner.github.io).
-
-## Further help
-
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
+## Installation
+
+Angular version `16.x.x`
+```bash
+$ npm install --save ngx-nz-formly
+```
+
+## Quick Start
+
+Adding ``ngx-nz-formly`` to your application is super easy. All you need is to add the following modules to imports in ``app.module.ts``. 
+```
+@NgModule({
+  declarations: [...],
+  imports: [
+    ...,
+    OverlayModule,
+    HttpClientModule,
+    BrowserAnimationsModule,
+    NgxMaskModule.forRoot({}),
+    FormlyModule.forRoot(NzFormlyForRoot),
+  ],
+  providers: [
+    ...,
+    { provide: NZ_I18N, useValue: en_US }
+  ],
+})
+export class AppModule {}
+```
+As an explanation, ``HttpClientModule`` and ``providers`` relates to Ant design setup.
+In order to use special masks on inputs, you need to add ``NgxMaskModule``, too. At last, we have ``OverlayModule``, ``BrowserAnimationsModule`` and ``FormlyModule`` to complete the setup.
+Finally, you need ``NzFormlyForRoot`` config to FormlyModule for root to be able to have your formly with Ant Design.

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "ngx-nz-formly",
-  "version": "0.0.4",
+  "version": "0.0.5",
+  "description": "awesome ngx nz formly",
   "peerDependencies": {
     "@angular/common": "^16.2.0",
     "@angular/core": "^16.2.0",
@@ -11,8 +12,32 @@
     "ngx-mask": "^13.1.3",
     "rxjs": "~7.5.0"
   },
+  "keywords": [
+    "nz",
+    "ng",
+    "ng2",
+    "zorro",
+    "formly",
+    "angular",
+    "nz-formly",
+    "ng2-nz-formly",
+    "ngx-nz-formly",
+    "angular-formly",
+    "ant-design-formly",
+    "ng2formly"
+  ],
+  "author": "sajjadbayat",
   "dependencies": {
     "tslib": "^2.3.0"
   },
+  "typings": "./src/public-api.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./src/public-api.ts"
+    }
+  },
   "sideEffects": false
 }