Update README.md

.github/README.md

@@ -1,6 +1,67 @@
-# Gemini-Tooluse-Prototype
-A prototype of a Gemini 1.5 Flash chatbot with Tooluse using a demo API implemented in Flask. It can use a calculator to perform basic arithmetic, get the current date and time, and search the web (using Selenium). Built in Python using Gradio and Flask
+# Gemini Tooluse Prototype
+A prototype of a Gemini 1.5 Flash chatbot with Tooluse using Flask, Gradio, Playwright, and Nginx. It can use a calculator, get the current date and time, and search the web (via Bing) using Playwright.
 
 https://huggingface.co/spaces/xarical/Gemini-Tooluse-Prototype
 
-![demo_screenshot3](https://github.com/user-attachments/assets/dbd574c9-775b-4488-bab0-112754980ee1)
+![demo_screenshot3](https://github.com/user-attachments/assets/dbd574c9-775b-4488-bab0-112754980ee1)
+
+## Running locally
+
+In config.py, replace:
+```python
+tools_external_url = f"https://{os.environ['SPACE_HOST']}/tools"
+```
+With:
+```python
+tools_external_url = f"http://localhost:3000"
+```
+
+Then, in the terminal:
+```bash
+# Create and enter a virtual environment
+python -m venv venv
+source venv/bin/activate
+
+# Install Python dependencies
+pip install -r requirements.txt
+
+# Install Node.js dependencies
+npm install
+
+# Install Playwright dependencies
+npx playwright install
+
+# Run the app
+bash run.sh
+```
+
+The app will be available at http://localhost:7860 if nginx succesfully started, http://localhost:8080 otherwise.
+
+## Deploying
+
+### Hugging Face Spaces
+1. Create a new Space in Hugging Face.
+2. Set any required secrets (e.g., `GEMINI_API_KEY`) in your Space settings.
+3. Push the files in this repository to your Hugging Face Space:
+   ```shell
+   git clone https://github.com/xarical/Gemini-Tooluse-Prototype
+   git remote add space https://YOUR_USERNAME:YOUR_ACCESS_TOKEN@huggingface.co/spaces/YOUR_USERNAME/YOUR_SPACE_NAME
+   git push --force space main
+   ```
+
+## Project files
+- `config.py` - Configuration for hosts, ports, and system prompt
+- `Dockerfile` - Dockerfile for Hugging Face deployment
+- `nginx.conf` - nginx config for Hugging Face deployment
+- `README.md` - You are here!
+- `requirements.txt` - Python dependencies
+- `package.json` - Node.js dependencies
+- `package-lock.json` - Node.js lockfile
+- `playwright_service.js` - Node.js service for browser-based web search
+- `tools.py` - Flask API for datetime, calculator, and websearch tools
+- `app.py` - Main Gemini chatbot app (Flask + Gradio)
+- `run.sh` - Shell script to start all services
+
+### `.github/workflows/`
+- `checkfilesizes.yml` - Check file sizes for pull requests (LFS)
+- `deploytospace.yml` - Deploy to Hugging Face Space automatically