From eac0c6caae2eacb280c89855e97201a0b3e91363 Mon Sep 17 00:00:00 2001 From: Jaysinh Padhiyar <34715991+Aremstrom@users.noreply.github.com> Date: Sun, 17 Mar 2024 16:07:36 +0530 Subject: [PATCH] Update README.md Created Redme File --- README.md | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 58 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3ccfa8e..46522c8 100644 --- a/README.md +++ b/README.md @@ -1 +1,58 @@ -"# Chat-With-CSV" +# Chat with CSV 🤖📊💬 + +## Description + +Chat with CSV is an interactive tool designed to enable users to upload CSV files and perform commands or queries on the data within the CSV file. It serves as an analytic tool, allowing users to interact with their data using natural language commands. + +## Table of Contents + +1. [Installation](#installation) +2. [Usage](#usage) +3. [Contributing](#contributing) + +## Installation + +To install Chat with CSV, follow these steps: + +1. Clone the repository: + + ```bash + git clone https://github.com/aremstrom/chat-with-csv.git + ``` + +2. Navigate to the project directory: + + ```bash + cd chat-with-csv + ``` + +3. Install the required dependencies: + + ```bash + pip install -r requirements.txt + ``` + +## Usage + +1. Run the application: + + ```bash + streamlit run app.py + ``` + +2. Upload your CSV file when prompted. + +3. Start typing your commands or queries in the chat interface. + +4. Get responses based on your input commands or queries. + +## Contributing + +Contributions are welcome! Here's how you can contribute: + +1. Fork the repository. +2. Create a new branch (`git checkout -b feature-new-feature`). +3. Make your changes. +4. Commit your changes (`git commit -am 'Add new feature'`). +5. Push to the branch (`git push origin feature-new-feature`). +6. Create a new Pull Request.