From 12fa9b8baea919aa6118c0c99c6904a43ef54d16 Mon Sep 17 00:00:00 2001
From: Meherzi Zied <zd.meherzi@gmail.com>
Date: Wed, 16 Jul 2025 10:01:08 +0100
Subject: [PATCH] Update README.md

Enhanced the README with clearer instructions and formatting to help beginners get started more easily.
---
 README.md | 83 +++++++++++++++++++++++++++++++++++++++++--------------
 1 file changed, 63 insertions(+), 20 deletions(-)

diff --git a/README.md b/README.md
index 678d8ef..9eaf0cb 100644
--- a/README.md
+++ b/README.md
@@ -1,38 +1,81 @@
-# Ted, The Deep-Learning Chatbot
+# 🤖 Ted – Your Deep-Learning Chatbot
 
-## About this Project
-Ted is a multipurpose chatbot made using Python3, who can chat with you and help in performing daily tasks. It uses NLP and Deep-Learning to analyse the user's message, classify it into the a broader category and then reply with a suitable message or the required information. It is hosted using flask and is available on heroku at the link specified above. 
+## 📌 About Ted
 
-## Project UI
-Home Page:
+Ted is a friendly chatbot built with **Python 3**, designed to chat and help you with simple daily tasks. It uses **Natural Language Processing (NLP)** and **Deep Learning** to understand your messages and respond intelligently.
 
-![image](https://raw.githubusercontent.com/Karan-Malik/Chatbot/master/UI/main_screen.PNG?token=AKGUW5C2TMM37OQE5FSPXLS66D55O)
+Ted runs on **Flask** and is hosted on **Heroku** (see link above).
 
-To run it locally on your system, follow these steps:
-1. Clone this repository onto your system. On Command Prompt, run the following command:
+---
 
-```
+## 🖥️ Project Preview
+
+**Homepage Screenshot:**
+
+![Ted UI](https://raw.githubusercontent.com/Karan-Malik/Chatbot/master/UI/main_screen.PNG?token=AKGUW5C2TMM37OQE5FSPXLS66D55O)
+
+---
+
+## 🚀 Getting Started (Run Locally)
+
+Follow these simple steps to run Ted on your own computer:
+
+### 1. Clone the Repository
+
+Open your terminal or command prompt and run:
+
+```bash
 git clone https://github.com/Karan-Malik/Chatbot.git
 ```
-2. Change your directory to Chatbot:
-```
+
+### 2. Move into the Project Folder
+
+```bash
 cd Chatbot
 ```
-3. Make sure you have all the required libraries listed in requirements.txt. In case any of the libraries are missing, install them using pip. Type this command into your Command Prompt, replacing 'Your-library-name' by the required library name:
-```
-pip install Your-library-name 
+
+### 3. Install the Required Libraries
+
+Check the `requirements.txt` file. To install any missing libraries, run:
+
+```bash
+pip install -r requirements.txt
 ```
-4. Then run the follwing commands to run the application:
+
+If `requirements.txt` doesn’t work, you can manually install any missing libraries like this:
+
+```bash
+pip install library-name
 ```
-set FLASK_APP=chatbot.py
+
+### 4. Run the Application
+
+Use these commands to start Ted locally:
+
+```bash
+set FLASK_APP=chatbot.py     # (on Windows)
 flask run
 ```
 
-5. Enter the url provided after running the previous commands into your web browser
+> 🔸 On macOS/Linux, use `export FLASK_APP=chatbot.py` instead.
+
+### 5. Open Ted in Your Browser
+
+After running, Flask will give you a local URL (e.g., `http://127.0.0.1:5000`).
+Open that in your browser — and Ted is ready to chat!
+
+---
+
+## 🙏 Special Thanks
+
+Thanks to these amazing contributors for their help with this project:
 
-Ted is now ready to chat!
+* [Ashutosh Varma](https://github.com/ashutoshvarma)
+* [Manorit Chawdhry](https://github.com/manorit2001)
 
-#### I would like to thank [Ashutosh Varma](https://github.com/ashutoshvarma) and [Manorit Chawdhry](https://github.com/manorit2001) for their help and contribution to this project. Do check out their Github accounts!
+Be sure to check out their work!
 
-##### Copyright (c) 2020 Karan-Malik
+---
 
+© 2020 [Karan Malik](https://github.com/Karan-Malik)
+Made with 💻 + ☕ + ❤️