diff --git a/readme.md b/readme.md index fca73fa..71824bb 100644 --- a/readme.md +++ b/readme.md @@ -9,11 +9,13 @@ Questo progetto è un bot di WhatsApp costruito con Node.js, utilizzando la libr Installazione --- **Required Node version > 12.x** + Per installare le dipendenze del progetto, esegui il seguente comando nel terminale: ```npm install``` 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 @@ -25,11 +27,15 @@ Il bot ha un **endpoint POST /send-message** che accetta un numero di telefono e 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 --- 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