docs: update README.md

.github/workflows/nodejs.yml

@@ -26,7 +26,7 @@ jobs:
           node-version: ${{ matrix.node-version }}
       - run: npm ci
       - run: npm run lint
-      - run: npm run build-for-prod
+      - run: npm run build
       - run: npm run ci-test
       - run: npm run ci-e2e
         env:

README.md

@@ -1,15 +1,38 @@
 # FormBuilderDemo
 
-This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 8.3.20.
+JSON-based Form builder Angular application. Uses [ng-zorro-antd](https://ng.ant.design/) as a UI component library.
 
-## Development server
+## Features
 
-Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
+Create a new form or edit one of the pre-built ones in the Form Builder UI which allows to:
+- Add or remove fields
+- Change field types (short/long text, date, number, checkbox, email, password)
+- Edit the form and field names
+- Edit field placeholders for the input types
+- Mark fields as required
+- Set the number of columns
 
-## Build
+## Standard commands
+### Install dependencies
 
-Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
+Run `npm i` to fetch node_modules.
 
-## Running unit tests
+### Start development server
 
-Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
+Run `npm start` for a dev server.
+Navigate to `http://localhost:4200/`.
+The app will automatically reload if you change any of the source files.
+
+### Build
+
+Run `npm run build` to build the project.
+The build artifacts will be stored in the `dist/` directory.
+
+### Testing
+
+- Run `npm test` to execute the unit tests via [Karma](https://karma-runner.github.io)
+- Run `npm run e2e` to execute the end-to-end tests via [Cypress](https://www.cypress.io)
+
+### Code style
+
+Run `npm run lint` to analyze the code by [ESLint](https://eslint.org/)

package.json

@@ -4,11 +4,10 @@
   "scripts": {
     "ng": "ng",
     "start": "set NODE_OPTIONS=--openssl-legacy-provider && ng serve",
-    "build": "ng build",
-    "build-for-prod": "ng build --configuration production",
+    "build": "ng build --configuration production",
+    "lint": "ng lint",
     "test": "ng test",
     "ci-test": "ng test --karma-config=karma-ci.conf.js",
-    "lint": "ng lint",
     "e2e": "set NODE_OPTIONS=--openssl-legacy-provider && ng e2e",
     "ci-e2e": "ng e2e --headless --no-watch",
     "cypress:open": "cypress open",
@@ -59,4 +58,4 @@
     "karma-jasmine-html-reporter": "^1.5.0",
     "typescript": "^4.9.5"
   }
-}
+}