diff --git a/README.md b/README.md index 7353fc9..2703058 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,19 @@ -# Whatsapp Link +# Whatsapp Link :iphone: Simple node for connecting Node-Red to Whatsapp. -Currently in developing mode, Continous updated may encounter. (#smileys--emotion) :iphone: +Currently in developing mode, Continous updated may encounter. -# -## To Connect with whatsapp +## 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 > 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. @@ -26,7 +25,7 @@ Currently in developing mode, Continous updated may encounter. (#smileys--emotio | destroy| Close the client and destroy the connection.| | restart | restart the whatsapp client | | logout | Simply log you out and close the session. | - | + | Output | Description | @@ -35,7 +34,7 @@ Currently in developing mode, Continous updated may encounter. (#smileys--emotio | 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. @@ -43,17 +42,17 @@ Currently in developing mode, Continous updated may encounter. (#smileys--emotio - 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. ---- +## Future Nodes Currently working on more Whatsapp Node and will be avilable soon - -1. **Group Message Node.** -2. **Chat Reply node.** -3. **Instruction (smart) 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.