Update README.md

README.md

@@ -5,6 +5,42 @@ colorFrom: purple
 colorTo: red
 sdk: docker
 pinned: false
+app_port: 8080
+short_description: Hosted OpenWebUI
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# OpenWebUI with Data Synchronization
+
+A self-hosted OpenWebUI instance with persistent data.
+
+## Features
+
+- 🤖 **OpenWebUI Interface**: Full-featured chat interface for AI models
+- 🔄 **Automated Data Sync**: Automatic backup to GitHub repository every 12 hours
+- 🔒 **Private Storage**: Secure data storage in your private GitHub repo
+- 📊 **Persistent Data**: Never lose your conversations and settings
+
+## Environment Variables
+
+Set these in your Space's Repository secrets:
+
+### Required
+- `G_NAME`: Your GitHub repository (e.g., `username/repo-name`)
+- `G_TOKEN`: GitHub Personal Access Token with repo access
+
+## Setup Instructions
+
+1. Create a private GitHub repository for data backup
+2. Generate a GitHub Personal Access Token with repo permissions
+3. Add the environment variables to your Space's Repository secrets
+4. Deploy and enjoy persistent OpenWebUI!
+
+## Data Synchronization
+
+The system automatically:
+- Syncs every 12 hours (London time)
+- Backs up `webui.db` to your GitHub repository
+- Creates versioned commits with timestamps
+- Handles conflicts and retries on failures
+
+Check out the [configuration reference](https://huggingface.co/docs/hub/spaces-config-reference) for more details.