4bnode 1.0.3 → 1.0.6

package/README.md

@@ -1,106 +1,116 @@
-# 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.
+
+Run any command using `npx`:
+
+```sh
+npx 4bnode <command>
+```
+
+Examples:
 
 ```sh
-npm install -g 4bnode
+npx 4bnode init my-project
+npx 4bnode add-mongo
+npx 4bnode add-serialport
 ```
 
 ## Available Commands
 
-### `4bnode init <projectName>`
+### `npx 4bnode init <projectName>`
 
 Initialize a new Node.js project with the specified name.
 
 ```sh
-4bnode init my-project
+npx 4bnode init my-project
 ```
 
-### `4bnode add-api <endpointName>`
+### `npx 4bnode add-api <endpointName>`
 
 Add a new API endpoint to your project.
 
 ```sh
-4bnode add-api users
+npx 4bnode add-api users
 ```
 
-### `4bnode add-mongo`
+### `npx 4bnode add-mongo`
 
 Integrate MongoDB into your project. This command sets up the necessary MongoDB configuration.
 
 ```sh
-4bnode add-mongo
+npx 4bnode add-mongo
 ```
 
-### `4bnode add-mongo-schema <schemaName>`
+### `npx 4bnode add-mongo-schema <schemaName>`
 
 Create a new MongoDB schema. You will be prompted to enter field details for the schema.
 
 ```sh
-4bnode add-mongo-schema User
+npx 4bnode add-mongo-schema User
 ```
 
-### `4bnode add-login`
+### `npx 4bnode add-login`
 
 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.
 
 ```sh
-4bnode add-login
+npx 4bnode add-login
 ```
 
-### `4bnode add-mongo-insert`
+### `npx 4bnode add-mongo-insert`
 
 Add a template for inserting data into a MongoDB collection. This command allows you to easily create routes for data insertion.
 
 ```sh
-4bnode add-mongo-insert
+npx 4bnode add-mongo-insert
 ```
 
-### `4bnode add-mongo-update`
+### `npx 4bnode add-mongo-update`
 
 Add a template for updating data in a MongoDB collection. This facilitates creating routes for updating documents.
 
 ```sh
-4bnode add-mongo-update
+npx 4bnode add-mongo-update
 ```
 
-### `4bnode add-mongo-read`
+### `npx 4bnode add-mongo-read`
 
 Add a template for reading data from a MongoDB collection, helping you to quickly set up read operations.
 
 ```sh
-4bnode add-mongo-read
+npx 4bnode add-mongo-read
 ```
 
-### `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.
 
 ```sh
-4bnode add-mongo-delete
+npx 4bnode add-mongo-delete
 ```
 
-### `4bnode add-socket`
+### `npx 4bnode add-socket`
 
 Integrate Socket.io into your project for real-time communication capabilities.
 
 ```sh
-4bnode add-socket
+npx 4bnode add-socket
 ```
 
-### `4bnode add-websocket`
+### `npx 4bnode add-websocket`
 
 Add native WebSocket support to your project.
 
 ```sh
-4bnode add-websocket
+npx 4bnode add-websocket
 ```
 
-### `4bnode add-serialport`
+### `npx 4bnode add-serialport`
 
 Integrate SerialPort functionality into your project. This command does the following:
 
@@ -110,7 +120,7 @@ Integrate SerialPort functionality into your project. This command does the foll
 - Installs required dependencies: `serialport` and `@serialport/parser-readline`
 
 ```sh
-4bnode add-serialport
+npx 4bnode add-serialport
 ```
 
 Once added, your project will automatically initialize the serial port with the specified configuration and log incoming data.
@@ -128,7 +138,7 @@ Received data: <data from serial device>
 When you run the command to add a MongoDB schema, you will be prompted to enter the field details.
 
 ```sh
-4bnode add-mongo-schema User
+npx 4bnode add-mongo-schema User
 ```
 
 ### Adding a Login Template
@@ -136,7 +146,7 @@ When you run the command to add a MongoDB schema, you will be prompted to enter
 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.
 
 ```sh
-4bnode add-login
+npx 4bnode add-login
 ```
 
 ## Real-time Communication Integration
@@ -146,7 +156,7 @@ When you run the command to add a login template, you will be prompted to select
 When you add WebSocket integration, it will automatically be added to your project.
 
 ```sh
-4bnode add-websocket
+npx 4bnode add-websocket
 ```
 
 To use `req.wss` in your route endpoints, you can access the WebSocket server as follows:
@@ -167,7 +177,7 @@ router.get("/some-endpoint", (req, res) => {
 When you add Socket.io integration, it will automatically be added to your project.
 
 ```sh
-4bnode add-socket
+npx 4bnode add-socket
 ```
 
 To use `req.io` in your route endpoints, you can access the Socket.io server as follows:
@@ -190,8 +200,8 @@ 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.6",
+  "description": "A professional tool to generate a Node.js app by 4Brains Technologies",
   "main": "index.js",
   "type": "module",
   "bin": {