From fd655423899d7bbbe51a561eb86404d3f63eadf9 Mon Sep 17 00:00:00 2001 From: Simone Gallo Date: Thu, 18 Apr 2024 12:44:37 +0200 Subject: [PATCH] fix readme --- readme.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/readme.md b/readme.md index 505771e..a151c76 100644 --- a/readme.md +++ b/readme.md @@ -2,28 +2,33 @@ - Documentazione: https://docs.wwebjs.dev/index.html - Esempi di funzioni della libreria: https://github.com/pedroslopez/whatsapp-web.js/blob/main/example.js -##Documentazione del Progetto WhatsApp Bot +Documentazione del Progetto WhatsApp Bot +--- Questo progetto è un bot di WhatsApp costruito con Node.js, utilizzando la libreria whatsapp-web.js per interagire con l'API di WhatsApp Web e express per creare un server web. -##Installazione +Installazione +--- Per installare le dipendenze del progetto, esegui il seguente comando nel terminale: npm install -##Uso +Uso +--- Per avviare il bot, esegui il seguente comando nel terminale: node main.js - Quando il bot è pronto, visualizzerà un QR code nel terminale. Scansiona questo QR code con l'applicazione WhatsApp sul tuo telefono per collegare il bot al tuo account WhatsApp. -##Endpoint +Endpoint +--- Il bot ha un endpoint POST /send-message che accetta un numero di telefono e un messaggio nel corpo della richiesta. Quando riceve una richiesta a questo endpoint, invia il messaggio al numero di telefono specificato. Esempio di richiesta: curl -X POST -H "Content-Type: application/json" -d '{"number": "39XXXXXXX@c.us", "message": "Ciao!"}' http://localhost:3000/send-message -##Eventi +Eventi +--- Il bot ascolta i seguenti eventi: ready: Questo evento viene emesso quando il bot è pronto per l'uso. qr: Questo evento viene emesso quando il bot ha bisogno di mostrare un QR code per l'autenticazione. message_create: Questo evento viene emesso quando il bot riceve un messaggio. Attualmente, il bot risponde a tutti i messaggi con un messaggio predefinito. -##Funzioni +Funzioni +--- Il bot ha la seguente funzione: sendMessage(number, message): Questa funzione invia un messaggio al numero di telefono specificato. \ No newline at end of file