4bnode 1.0.5 → 1.0.7

package/README.md

@@ -26,70 +26,116 @@ npx 4bnode add-serialport
 
 Initialize a new Node.js project with the specified name.
 
+```sh
+npx 4bnode init my-project
+```
+
 ### `npx 4bnode add-api <endpointName>`
 
 Add a new API endpoint to your project.
 
+```sh
+npx 4bnode add-api users
+```
+
 ### `npx 4bnode add-mongo`
 
 Integrate MongoDB into your project. This command sets up the necessary MongoDB configuration.
 
+```sh
+npx 4bnode add-mongo
+```
+
 ### `npx 4bnode add-mongo-schema <schemaName>`
 
 Create a new MongoDB schema. You will be prompted to enter field details for the schema.
 
+```sh
+npx 4bnode add-mongo-schema User
+```
+
 ### `npx 4bnode add-login`
 
-Add a login template to an existing route in your project.
+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
+npx 4bnode add-login
+```
 
 ### `npx 4bnode add-mongo-insert`
 
-Add a route for inserting data into a MongoDB collection.
+Add a template for inserting data into a MongoDB collection. This command allows you to easily create routes for data insertion.
+
+```sh
+npx 4bnode add-mongo-insert
+```
 
 ### `npx 4bnode add-mongo-update`
 
-Add a route for updating data in a MongoDB collection.
+Add a template for updating data in a MongoDB collection. This facilitates creating routes for updating documents.
+
+```sh
+npx 4bnode add-mongo-update
+```
 
 ### `npx 4bnode add-mongo-read`
 
-Add a route for reading data from a MongoDB collection.
+Add a template for reading data from a MongoDB collection, helping you to quickly set up read operations.
+
+```sh
+npx 4bnode add-mongo-read
+```
 
 ### `npx 4bnode add-mongo-delete`
 
-Add a route for deleting data from a MongoDB collection.
+Add a template for deleting data from a MongoDB collection, making it easy to handle deletion operations.
+
+```sh
+npx 4bnode add-mongo-delete
+```
 
 ### `npx 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
+npx 4bnode add-socket
+```
 
 ### `npx 4bnode add-websocket`
 
 Add native WebSocket support to your project.
 
+```sh
+npx 4bnode add-websocket
+```
+
 ### `npx 4bnode add-serialport`
 
-Integrate SerialPort functionality into your project. This command:
+Integrate SerialPort functionality into your project. This command does the following:
 
 - Prompts for Serial Port path and baud rate
-- Updates `.env.development` and `.env.production`
-- Injects SerialPort setup code into your `index.js`
-- Installs required packages
-
-Once added, incoming data will be logged like:
+- 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`
 
 ```sh
-Received data: <data from serial device>
+npx 4bnode add-serialport
 ```
 
-## Examples
+Once added, your project will automatically initialize the serial port with the specified configuration and log incoming data.
 
-### Creating a New Project
+Example incoming data log:
 
 ```sh
-npx 4bnode init my-app
+Received data: <data from serial device>
 ```
 
-### Adding a MongoDB Schema
+## Examples
+
+### Adding MongoDB Schema
+
+When you run the command to add a MongoDB schema, you will be prompted to enter the field details.
 
 ```sh
 npx 4bnode add-mongo-schema User
@@ -97,19 +143,23 @@ npx 4bnode add-mongo-schema User
 
 ### 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.
+
 ```sh
 npx 4bnode add-login
 ```
 
-### Integrating SerialPort
+## Real-time Communication Integration
+
+### WebSocket Integration
+
+When you add WebSocket integration, it will automatically be added to your project.
 
 ```sh
-npx 4bnode add-serialport
+npx 4bnode add-websocket
 ```
 
-## Real-time Communication Integration
-
-### WebSocket
+To use `req.wss` in your route endpoints, you can access the WebSocket server as follows:
 
 ```js
 router.get("/some-endpoint", (req, res) => {
@@ -122,7 +172,15 @@ router.get("/some-endpoint", (req, res) => {
 });
 ```
 
-### Socket.io
+### Socket.io Integration
+
+When you add Socket.io integration, it will automatically be added to your project.
+
+```sh
+npx 4bnode add-socket
+```
+
+To use `req.io` in your route endpoints, you can access the Socket.io server as follows:
 
 ```js
 router.get("/some-endpoint", (req, res) => {
@@ -133,6 +191,14 @@ 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
 npx 4bnode -h
 npx 4bnode --help

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "4bnode",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "A professional tool to generate a Node.js app by 4Brains Technologies",
   "main": "index.js",
   "type": "module",
@@ -12,7 +12,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/pawan-4brains/4brains-node-generator"
+    "url": "https://github.com/pawan-4brains/4bnode"
   },
   "keywords": [
     "node",