Update README.md

Author: noguerajulioces

README.md

@@ -1,25 +1,78 @@
-# README
+# ReminderIA - RoR
 
-This README would normally document whatever steps are necessary to get the
-application up and running.
+## Description
 
-Things you may want to cover:
+This project is a ReminderIA, allowing users to manage reminders via WhatsApp using AI (OpenAI) to interpret natural language commands. The application is built with Ruby on Rails and leverages services to maintain modular and clean code.
 
-* Ruby version
+## Features
 
-* System dependencies
+- **WhatsApp Integration**: Users can send text messages to create, edit, or delete reminders.
+- **AI for Natural Language Processing**: Utilizes OpenAI to interpret user commands and create reminders.
+- **Reminder Management**: Users can manage their reminders, including creating, editing, and deleting.
+- **Context Handling**: The app maintains conversation context to provide more accurate responses.
 
-* Configuration
+## Project Structure
 
-* Database creation
+- **Models**
+    - `User`: Stores user information.
+    - `Reminder`: Stores user reminders.
+    - `Message`: Logs sent and received messages.
+    - `Conversation`: Stores conversation context.
 
-* Database initialization
+- **Services**
+    - `OpenAIService`: Handles interaction with the OpenAI API.
+    - `ReminderService`: Manages the creation of reminders based on OpenAI responses.
 
-* How to run the test suite
+- **Controllers**
+    - `RemindersController`: Handles CRUD actions for reminders.
+    - `MessagesController`: Processes incoming WhatsApp messages and sends responses.
 
-* Services (job queues, cache servers, search engines, etc.)
+## Installation
 
-* Deployment instructions
+1. Clone this repository:
 
-* ...
-# whatsapp-with-OpenAI
+   ```bash
+    git clone https://github.com/noguerajulioces/whatsapp-with-OpenAI.git
+    ```
+
+2. Install dependencies:
+
+   ```bash
+   bundle install
+   ```
+
+3. Set up the database:
+
+   ```bash
+   rails db:create db:migrate
+   ```
+
+4. Configure your OpenAI and Twilio credentials in your `.env` file.
+
+5. Run the server:
+
+   ```bash
+   rails s
+   ```
+
+## Usage
+
+1. Set up your WhatsApp account to send messages to the app.
+2. Send messages with natural commands like "Remind me to buy milk tomorrow at 10 AM."
+3. The app will process the command, create a reminder, and respond with a confirmation.
+
+## Contributions
+
+Contributions are welcome. Please follow these steps:
+
+1. Fork the project.
+2. Create a new branch (`git checkout -b feature/new-feature`).
+3. Make your changes and commit (`git commit -m 'Add new feature'`).
+4. Push to the branch (`git push origin feature/new-feature`).
+5. Open a Pull Request.
+
+## License
+
+This project is licensed under the MIT License.
+
+---