update readme

Author: haroldeustaquio

README.md

@@ -1,47 +1,32 @@
 # WhatsApp Automation Bot
 
-## Introduction
-This repository contains two projects focused on automating the process of sending messages and file attachments through WhatsApp. Both projects use WhatsApp Web for the message delivery mechanism but leverage different tools and approaches for automation. These solutions can be used to send timely alerts based on various triggers, ensuring fast and efficient communication directly through WhatsApp.
-
----
-
-## Project 1: WhatsApp-Selenium-Bot
+## Overview
+This repository is focused on automating the process of sending messages and file attachments through WhatsApp. This project use WhatsApp Web for the message delivery mechanism but leverage different tools and approaches for automation. These solutions can be used to send timely alerts based on various triggers, ensuring fast and efficient communication directly through WhatsApp.
 
-### Overview
-The **WhatsApp-Selenium-Bot** project automates sending alerts through WhatsApp using the Selenium framework. This project is designed to handle real-time data extraction, processing, and report generation. Based on certain conditions, such as temperature or humidity thresholds, it triggers alerts that are sent via WhatsApp, ensuring prompt notifications. The alerts can include both text messages and file attachments, such as detailed reports in Excel format.
+**Structure**:
+- [Introduction](#introduction)
+- [Message Sender](#message-sender)
+  - [Key Features](#key-features)
+  - [File Structure](#file-structure)
 
-### Folder Structure
-- **Messages Folder**: Contains scripts responsible for sending alerts as text messages without attachments.
-- **Messages and Files Folder**: Includes the core functionality to handle both text messages and file attachments. 
 
-Scripts here:
-  - Connect to databases, extract and clean data.
-  - Generate and format Excel reports.
-  - Send notifications and files through WhatsApp Web.
-
-### Key Features
-- **Automated Alerts**: Automatically detects specific conditions and sends corresponding WhatsApp alerts.
-- **File Attachments**: The bot generates reports, such as Excel files, and sends them alongside alert messages.
-- **Data Processing**: Integrates data extraction, cleaning, and processing before generating and sending alerts.
+---
 
-### Limitations
-- **WhatsApp Web Session**: An active WhatsApp Web session is required for the automation to function. If the session is interrupted, alerts will not be sent.
-- **Server Dependence**: Continuous server uptime is essential. Any server failure can result in missed alerts.
+## Introduction
+The **WhatsApp-js-Bot** project uses the `whatsapp-web.js` API to automate sending messages and files through WhatsApp. The bot initiates a session by scanning a QR code and remains active to send periodic messages and file attachments to designated WhatsApp numbers or groups. This project is highly customizable, allowing users to modify the target recipients, messages, and files to fit various use cases.
 
 ---
 
-## Project 2: WhatsApp-js-Bot
-
-### Overview
-The **WhatsApp-js-Bot** project uses the `whatsapp-web.js` API to automate sending messages and files through WhatsApp. The bot initiates a session by scanning a QR code and remains active to send periodic messages and file attachments to designated WhatsApp numbers or groups. This project is highly customizable, allowing users to modify the target recipients, messages, and files to fit various use cases.
+## Message Sender
 
 ### Key Features
 - **QR Code Login**: The bot uses WhatsApp Web by scanning a QR code to authenticate and log in.
 - **Send Messages and Files**: It can send both text messages and files to a target WhatsApp number or group.
 - **Session Keep Alive**: Includes functionality to keep the WhatsApp session active, avoiding the need for constant re-authentication.
-  
+
+
 ### File Structure
 - **whatsapp-client.js**: Initializes the WhatsApp client, handles QR code generation, and manages sending text messages and files.
 - **sendMessage.js**: Defines the function that sends a text message to a specified WhatsApp number.
 - **sendFile.js**: Exports the function to send file attachments to a specified number or group.
-- **keepAlive.js**: Ensures the session stays active by periodically sending logs to prevent disconnection.
+- **keepAlive.js**: Ensures the session stays active by periodically sending logs to prevent disconnection.

message-sender/README.md

@@ -0,0 +1,91 @@
+# WhatsApp-js-Bot
+
+This project is an automation bot for sending messages and files over WhatsApp using the `whatsapp-web.js` API. The bot scans a QR code to log in, keeps the session active, and sends messages and files periodically to a specific WhatsApp number or group.
+
+---
+## Features
+
+### `whatsapp-client.js`
+This is the main file that initializes the WhatsApp client. It includes the following functions:
+- **`qrcode`**: Generates a QR code that you need to scan with the WhatsApp app to log in.
+- **`sendMessage`**: Sends a text message to the target number or group.
+- **`sendFile`**: Sends a file to the target number or group.
+- **`keepAlive`**: Keeps the WhatsApp session active by sending periodic logs to avoid disconnections.
+
+### `sendMessage.js`
+This file exports a function that sends a text message to a WhatsApp number:
+
+**Parameters**:
+- `client`: Instance of the WhatsApp client.
+- `number`: WhatsApp number (in `[email protected]` format).
+- `message`: The text of the message to send.
+
+### `sendFile.js`
+This file exports a function that sends a file to a WhatsApp number:
+
+**Parameters**:
+- `client`: WhatsApp client instance.
+- `number`: WhatsApp number (in `[email protected]` format).
+- `filePath`: Local path of the file to be sent.
+- `fileName`: Name of the file to display on WhatsApp.
+
+### `keepAlive.js`
+This file exports a function that keeps the WhatsApp session active:
+
+**Function**:
+- Runs a periodic function (every 5 minutes) that keeps the session alive by printing a message to the console.
+---
+
+## Installation
+
+To run this project, make sure you have Node.js installed and follow these steps:
+
+### 1. Clone the repository
+
+```bash
+git clone https://github.com/haroldeustaquio/alert-system-whatsapp.git
+```
+
+### 2. Go to the whatsapp-js-bot folder
+```bash
+cd whatsapp-js-bot
+```
+
+### 3. Install dependencies:
+```bash
+npm install whatsapp-web.js qrcode-terminal fs
+```
+
+### 4. Run the bot
+```bash
+node whatsapp-client.js
+```
+
+### 5. Scan QR code
+
+Once you run the bot, a QR code will be generated in the terminal. Scan it with the WhatsApp app to log in.
+
+---
+
+## Usage
+
+Modify the ``whatsapp-client.js`` file with the destination number and the file you want to send:
+
+- Number: You must use the format ``[email protected]`` for numbers in Peru.
+- Message: You can customize the text message to send.
+- File: Change the file path and its name if you want to send a different file.
+- Interval: Change the number of ms to send messages automatically
+
+---
+
+## Dependencies 
+- whatsapp-web.js 
+- qrcode-terminal 
+- fs
+
+---
+
+## Additional Notes
+
+- If the file does not exist or the path is incorrect, the bot will throw an error indicating that the file was not found.
+- To send messages to a group, replace the number with the group ID in WhatsApp.