From 4139f21dc7a8f4e36b6c0d73ef8d3fdcf59317ad Mon Sep 17 00:00:00 2001 From: rawee Date: Wed, 7 Dec 2022 00:12:50 +0530 Subject: [PATCH] Readme Updated --- README.md | 61 +++++++++++++++++++++++++++++++++++++++++----------- package.json | 2 +- 2 files changed, 50 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index f813e27..7353fc9 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,62 @@ -# Whatsapp Bot +# Whatsapp Link -Simple Node for connecting Node-Red to Whatsapp. +Simple node for connecting Node-Red to Whatsapp. -Currently in developing mode, Continous updated may encounter. +Currently in developing mode, Continous updated may encounter. (#smileys--emotion) :iphone: -To Connect with whatsapp- -1. Deploy the any whatsapp node with whatsappLink node. -2. look in Console/Bash/terminal. +# +## To Connect with whatsapp +1. Deploy any whatsapp node along with whatsappLink node. +2. look in Console/ Bash/ terminal. 3. whatsappLink node will initilize, connect with whatsapp and generate a QR code it terminal. -4. Scan the QR code with your Whatsapp Mobile App (Go to settings > Linked device). +4. Scan the QR code with your Whatsapp Mobile App (Go to settings > Linked device > Scan & Connect). 5. Done - Whatsapp Connected. - It will create a Whatsapp Web instance in your machine and store your session locally in Node-RED. +> It will create a Whatsapp Web instance in your machine and store your session locally in Node-RED. + +--- +## Nodes +1. **Whatsapp Admin** : Node used for basic status of whatsapp. + + | Inputs | Description | + |--------|-------------- | + | test | Checks the current status of whatsapp and output the same in `msg.payload`| + | destroy| Close the client and destroy the connection.| + | restart | restart the whatsapp client | + | logout | Simply log you out and close the session. | + | + + + | Output | Description | + |--------| ------------| + |`status` | provide status on `msg.payload` for all and each input mentioned in above table. | + | Connecting..| When whatsapp attempting to connect. + | QR Code (image) | when QR code is generated. *This method can also be used to get QR Code (image) generated by whatsapp.* + | Connected | When whatapp is sucessfully connected.| + --- + + +2. **Whatsapp In** : Node to recive all messages send to connected number. + - Simply deploy the node and wait for connected (green) status. + - After succesfully connection, Node is able to recive all messages. + - Messages can be read at `msg.payload` and `msg.body` and sender number can be read at `msg.from`. + - Please look complete `{msg}` to get all details about recived message. + --- + +3. **Whatsapp Out** : As simple as mention on name, node will send `msg.payload` recived at input to the number mentiond in node. + > Don't forget to mention international dialing code befor your number. Number must be in format like `+11 99999 99999` without any space. + +--- Currently working on more Whatsapp Node and will be avilable soon - -1. Group Message Node. -2. Chat Reply node. -3. Instruction Reply Node. +1. **Group Message Node.** +2. **Chat Reply node.** +3. **Instruction (smart) Reply Node**. Complete detail for Nodes will also be updated as soon as possible. -Thanks to bear with me :p +>Please don`t try to spam with your personal Number, Suspicious activities might be tracked by whatsapp. + +Thanks to bear with me diff --git a/package.json b/package.json index 30206c3..c85e60c 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "node-red-contrib-whatsapp-link", - "version": "0.1.13", + "version": "0.1.14", "description": "Whatsapp connection with Node-Red", "scripts": { "test": "echo \"Error: no test specified\" && exit 1"