fix readme

This commit is contained in:
Simone Gallo 2024-04-18 12:52:51 +02:00
parent 612b0f47af
commit 1ec7594904
1 changed files with 8 additions and 7 deletions

View File

@ -8,27 +8,28 @@ Questo progetto è un bot di WhatsApp costruito con Node.js, utilizzando la libr
Installazione Installazione
--- ---
Per installare le dipendenze del progetto, esegui il seguente comando nel terminale: npm install ** Required Node version > 12.x
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 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. 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. 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 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: Il bot ascolta i seguenti eventi:
ready: Questo evento viene emesso quando il bot è pronto per l'uso. - 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. - 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. - 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: Il bot ha la seguente funzione:
sendMessage(number, message): Questa funzione invia un messaggio al numero di telefono specificato. - sendMessage(number, message): Questa funzione invia un messaggio al numero di telefono specificato.