4bnode 1.0.3 → 1.0.5

package/README.md

@@ -1,121 +1,81 @@
-# 4Brains Node CLI
+# 4Brains Node Tool
 
-A comprehensive CLI tool to streamline the generation and management of Node.js applications by 4Brains Technologies.
+A professional tool to streamline the generation and management of Node.js applications by 4Brains Technologies.
 
-## Installation
+## Usage via NPX
 
-To install the 4Brains Node CLI globally, use the following command:
+No global installation needed.
 
-```sh
-npm install -g 4bnode
-```
-
-## Available Commands
-
-### `4bnode init <projectName>`
-
-Initialize a new Node.js project with the specified name.
+Run any command using `npx`:
 
 ```sh
-4bnode init my-project
+npx 4bnode <command>
 ```
 
-### `4bnode add-api <endpointName>`
-
-Add a new API endpoint to your project.
+Examples:
 
 ```sh
-4bnode add-api users
+npx 4bnode init my-project
+npx 4bnode add-mongo
+npx 4bnode add-serialport
 ```
 
-### `4bnode add-mongo`
-
-Integrate MongoDB into your project. This command sets up the necessary MongoDB configuration.
+## Available Commands
 
-```sh
-4bnode add-mongo
-```
+### `npx 4bnode init <projectName>`
 
-### `4bnode add-mongo-schema <schemaName>`
+Initialize a new Node.js project with the specified name.
 
-Create a new MongoDB schema. You will be prompted to enter field details for the schema.
+### `npx 4bnode add-api <endpointName>`
 
-```sh
-4bnode add-mongo-schema User
-```
+Add a new API endpoint to your project.
 
-### `4bnode add-login`
+### `npx 4bnode add-mongo`
 
-Add a login template to an existing route in your project. You will be prompted to select a route and a model, and then enter the login fields.
+Integrate MongoDB into your project. This command sets up the necessary MongoDB configuration.
 
-```sh
-4bnode add-login
-```
+### `npx 4bnode add-mongo-schema <schemaName>`
 
-### `4bnode add-mongo-insert`
+Create a new MongoDB schema. You will be prompted to enter field details for the schema.
 
-Add a template for inserting data into a MongoDB collection. This command allows you to easily create routes for data insertion.
+### `npx 4bnode add-login`
 
-```sh
-4bnode add-mongo-insert
-```
+Add a login template to an existing route in your project.
 
-### `4bnode add-mongo-update`
+### `npx 4bnode add-mongo-insert`
 
-Add a template for updating data in a MongoDB collection. This facilitates creating routes for updating documents.
+Add a route for inserting data into a MongoDB collection.
 
-```sh
-4bnode add-mongo-update
-```
+### `npx 4bnode add-mongo-update`
 
-### `4bnode add-mongo-read`
+Add a route for updating data in a MongoDB collection.
 
-Add a template for reading data from a MongoDB collection, helping you to quickly set up read operations.
+### `npx 4bnode add-mongo-read`
 
-```sh
-4bnode add-mongo-read
-```
+Add a route for reading data from a MongoDB collection.
 
-### `4bnode add-mongo-delete`
+### `npx 4bnode add-mongo-delete`
 
-Add a template for deleting data from a MongoDB collection, making it easy to handle deletion operations.
+Add a route for deleting data from a MongoDB collection.
 
-```sh
-4bnode add-mongo-delete
-```
+### `npx 4bnode add-socket`
 
-### `4bnode add-socket`
+Integrate Socket.io into your project for real-time communication.
 
-Integrate Socket.io into your project for real-time communication capabilities.
-
-```sh
-4bnode add-socket
-```
-
-### `4bnode add-websocket`
+### `npx 4bnode add-websocket`
 
 Add native WebSocket support to your project.
 
-```sh
-4bnode add-websocket
-```
+### `npx 4bnode add-serialport`
 
-### `4bnode add-serialport`
-
-Integrate SerialPort functionality into your project. This command does the following:
+Integrate SerialPort functionality into your project. This command:
 
 - Prompts for Serial Port path and baud rate
-- Automatically updates `.env.development` and `.env.production` with `SERIALPORT_PATH` and `BAUDRATE`
-- Adds SerialPort and Readline parser setup to your `index.js`
-- Installs required dependencies: `serialport` and `@serialport/parser-readline`
+- Updates `.env.development` and `.env.production`
+- Injects SerialPort setup code into your `index.js`
+- Installs required packages
 
-```sh
-4bnode add-serialport
-```
-
-Once added, your project will automatically initialize the serial port with the specified configuration and log incoming data.
-
-Example incoming data log:
+Once added, incoming data will be logged like:
 
 ```sh
 Received data: <data from serial device>
@@ -123,33 +83,33 @@ Received data: <data from serial device>
 
 ## Examples
 
-### Adding MongoDB Schema
-
-When you run the command to add a MongoDB schema, you will be prompted to enter the field details.
+### Creating a New Project
 
 ```sh
-4bnode add-mongo-schema User
+npx 4bnode init my-app
 ```
 
-### Adding a Login Template
-
-When you run the command to add a login template, you will be prompted to select a route and a model, and then enter the login fields.
+### Adding a MongoDB Schema
 
 ```sh
-4bnode add-login
+npx 4bnode add-mongo-schema User
 ```
 
-## Real-time Communication Integration
+### Adding a Login Template
 
-### WebSocket Integration
+```sh
+npx 4bnode add-login
+```
 
-When you add WebSocket integration, it will automatically be added to your project.
+### Integrating SerialPort
 
 ```sh
-4bnode add-websocket
+npx 4bnode add-serialport
 ```
 
-To use `req.wss` in your route endpoints, you can access the WebSocket server as follows:
+## Real-time Communication Integration
+
+### WebSocket
 
 ```js
 router.get("/some-endpoint", (req, res) => {
@@ -162,15 +122,7 @@ router.get("/some-endpoint", (req, res) => {
 });
 ```
 
-### Socket.io Integration
-
-When you add Socket.io integration, it will automatically be added to your project.
-
-```sh
-4bnode add-socket
-```
-
-To use `req.io` in your route endpoints, you can access the Socket.io server as follows:
+### Socket.io
 
 ```js
 router.get("/some-endpoint", (req, res) => {
@@ -181,17 +133,9 @@ router.get("/some-endpoint", (req, res) => {
 
 ## Help
 
-If you enter an invalid command, you will see the following message:
-
-```sh
-Unknown command. Use -h or --help for help.
-```
-
-You can also use `-h` or `--help` to get help information.
-
 ```sh
-4bnode -h
-4bnode --help
+npx 4bnode -h
+npx 4bnode --help
 ```
 
 ## License

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "4bnode",
-  "version": "1.0.3",
-  "description": "A CLI tool to generate a Node.js app by 4Brains Technologies",
+  "version": "1.0.5",
+  "description": "A professional tool to generate a Node.js app by 4Brains Technologies",
   "main": "index.js",
   "type": "module",
   "bin": {