Add README with Space configuration

README.md

@@ -1,67 +1,29 @@
-# Chat with PDF
-
-This Python project that allows you to chat with a chatbot about the PDF you uploaded. and generate a PDF transcript of the conversation. The project is built using Python and Streamlit framework.
-
-
-This is a fork from https://github.com/sudan94/chat-pdf-hugginface. I had issues install the requirements.txt, thus I removed the '==version' in requirements.txt with 
-```shell
-sed -i 's/\=.*//g' requirements.txt
-```
-Then, I added some modules that are needed for app.py that were not in requirements.txt.  
-
-A `conda` environment is used instead of `venv` virtual environment
-
-## Installation
-
-To run this project, please follow the steps below:
-
-1. Clone the repository:
-
-```shell
-git clone git@github.com:MattLondon101/chat-pdf-hugginface.git
-cd chat-pdf-hugginface
-```
-
-2. Create and activate a conda virtual environment (optional but recommended):
-
-```shell
-conda create -n env1 python=3.10
-conda activate env1
-```
-
-3. Install the dependencies from the `requirements.txt` file:
-
-```shell
-pip install -r requirements.txt
-```
-
-4. You will need a HUGGINGFACEHUB_API_TOKEN for this next step. To obtain one for free, got to https://huggingface.co/ and Sign Up for a free account. Then, go to Settings > Access Tokens. Create a New token. Then, create a file in this directory, name is `.env` and enter `HUGGINGFACEHUB_API_TOKEN = "token"`,  replacing `token` with your User Access Token. Save the `.env` file. The `.gitignore` file will ignore the `.env` for git operation.
-
-## Running the Project
-
-Once you have installed the required dependencies, you can run the project using Streamlit, which should have been installed with `requirements.txt`. Streamlit provides an easy way to create interactive web applications in Python.
-
-To start the application, run the following command:
-
-```shell
-streamlit run app.py
-```
-
-This will start the Streamlit server and open the application in your default web browser..  
-
-### Git flow
-`.gitit.sh` can be used for easy pushing updates to remote repo.  
-
-Activate with:  
-```shell
-chmod +x .gitit.sh
-```
-Then, to add, commit, and push to remote repo:
-```
-./gitit.sh
-```
-
-## License
-
-This project is licensed under the [MIT License](LICENSE).
-
+echo '---
+title: PDF Chatbot
+emoji: 📄
+colorFrom: blue
+colorTo: purple
+sdk: gradio
+sdk_version: 3.50.2
+app_file: app.py
+pinned: false
+---
+
+# PDF Question Answering Chatbot
+
+A chatbot that can answer questions about your PDF documents using AI.
+
+## Features
+- Upload any PDF document
+- Ask natural language questions
+- Get accurate answers from the document content
+
+## How to Use
+1. Upload a PDF file
+2. Ask questions about its content
+3. Get instant answers
+
+## Technical Details
+- Uses `deepset/roberta-base-squad2` model
+- Built with Gradio interface
+- Deployed on Hugging Face Spaces' > README.md