@ngflow/ng-architect 1.0.2 → 1.0.3

package/README.md

@@ -1,28 +1,43 @@
-# Getting Started With Schematics
+# ![ng-architect](https://img.shields.io/badge/ng--architect-angular-blue)
 
-This repository is a basic Schematic implementation that serves as a starting point to create and publish Schematics to NPM.
+[![npm version](https://img.shields.io/npm/v/@ngflow/ng-architect?color=blue)](https://www.npmjs.com/package/@ngflow/ng-architect) [![License](https://img.shields.io/npm/l/@ngflow/ng-architect)](https://opensource.org/licenses/MIT)
 
-### Testing
+`ng-architect` is an **Angular schematic** that automates the creation of **complete features** while keeping a clean and consistent **project structure and architecture**.  
 
-To test locally, install `@angular-devkit/schematics-cli` globally and use the `schematics` command line tool. That tool acts the same as the `generate` command of the Angular CLI, but also has a debug mode.
+It generates **pages, services, models, store, and routes**, making your development faster and more organized.
 
-Check the documentation with
+---
+
+## 📦 Installation
 
 ```bash
-schematics --help
+# Install as a dev dependency
+npm install @ngflow/ng-architect --save-dev
 ```
 
-### Unit Testing
-
-`npm run test` will run the unit tests, using Jasmine as a runner and test framework.
-
-### Publishing
+## Usage
+```bash 
+ng g @ngflow/ng-architect:ng-architect --name=<feature-name>
 
-To publish, simply do:
 
-```bash
-npm run build
-npm publish
+example: 
+ng g @ngflow/ng-architect:ng-architect --name=user-profile
 ```
 
-That's it!
+```bash
+This will create the following structure:
+
+src/app/features/user-profile/
+ ├─ data/
+ │   ├─ user-profile.service.ts
+ │   └─ user-profile.store.ts
+ ├─ models/
+ │   └─ user-profile.model.ts
+ └─ pages/
+     ├─ user-profile.page.ts
+     ├─ user-profile.page.html
+     └─ user-profile.page.scss
+
+
+If app.routes.ts exists, the feature route will be added automatically.
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ngflow/ng-architect",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Angular schematics to generate files and maintain clean architecture",
   "scripts": {
     "build": "tsc -p tsconfig.json",