diff --git a/readme.md b/readme.md index a151c76..585d171 100644 --- a/readme.md +++ b/readme.md @@ -8,27 +8,28 @@ Questo progetto è un bot di WhatsApp costruito con Node.js, utilizzando la libr 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 --- -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. 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 +Esempio di richiesta: ```curl -X POST -H "Content-Type: application/json" -d '{"number": "39XXXXXXX@c.us", "message": "Ciao!"}' http://localhost:3000/send-message``` 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. +- 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 +- sendMessage(number, message): Questa funzione invia un messaggio al numero di telefono specificato. \ No newline at end of file