Update README.md

README.md

@@ -9,4 +9,99 @@ app_file: app.py
 pinned: false
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Facerec 📚
+
+![Facerec Banner](https://your-image-url.com/banner.png)
+
+**Facerec** is a comprehensive single-image face recognition system built with Gradio. Leveraging powerful technologies like YOLO for face detection, DeepSort for tracking, FaceNet for recognition, and Mediapipe for advanced functionalities such as blink detection, face mesh, eye color detection, and hand tracking, Facerec offers a robust solution for facial analysis and recognition tasks.
+
+## 🚀 Features
+
+- **Face Detection with YOLO:** High-precision face detection using the YOLO model.
+- **Face Tracking with DeepSort:** Efficient tracking of detected faces across multiple images.
+- **Face Recognition with FaceNet:** Accurate face recognition using deep learning embeddings.
+- **Anti-Spoofing:** Detects potential spoofing attempts by analyzing image sharpness.
+- **Blink Detection:** Identifies blinks using Eye Aspect Ratio (EAR) calculations.
+- **Face Mesh & Iris Detection:** Visualizes facial landmarks, contours, tesselation, and irises.
+- **Eye Color Detection:** Determines the dominant eye color from the iris region.
+- **Hand Tracking with Mediapipe Hands:** Detects and tracks hands, displaying landmarks and connections.
+- **Database Management:** 
+  - **Enroll Users:** Add multiple images per user for recognition.
+  - **Search Users:** Search by name or image to find matching users.
+  - **Remove Users:** Delete user data from the database.
+  - **List Users:** View all enrolled users.
+- **Customizable Configuration:** Toggle features, adjust thresholds, and customize colors via an intuitive interface.
+
+## 📥 Installation
+
+1. **Clone the Repository**
+   ```bash
+   git clone https://github.com/yourusername/facerec.git
+   cd facerec
+   ```
+
+2. **Create a Virtual Environment (Optional but Recommended)**
+   ```bash
+   python3 -m venv venv
+   source venv/bin/activate  # On Windows: venv\Scripts\activate
+   ```
+
+3. **Install Dependencies**
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+4. **Download YOLO Model**
+   The application automatically downloads the YOLO face detection model (`face2.pt`) if it's not present.
+
+## ⚙️ Setup
+
+1. **Initial Configuration**  
+   Customize settings via the **Configuration** tab in the Gradio interface.
+
+2. **Database Initialization**  
+   The face embeddings database is stored at `~/.face_pipeline/known_faces.pkl`.
+
+## 🛠️ Usage
+
+Launch the Gradio app by running:
+```bash
+python app.py
+```
+Access it at `http://localhost:7860/`.
+
+### Image Test
+
+1. **Upload an Image**
+2. **Process Image**
+3. **View Results**
+
+### Configuration
+
+Customize the application's behavior:
+- **Feature Toggles:** Enable/disable specific features.
+- **Thresholds:** Adjust confidence thresholds.
+- **Color Customization:** Define colors for bounding boxes and overlays.
+
+### Database Management
+
+Manage users via the **Database Management** tab:
+- **Enroll Users:** Upload images for recognition.
+- **Search Users:** Search by name or image.
+- **Remove Users:** Delete user data.
+
+## 📂 Database Management
+
+Facerec maintains a database at `~/.face_pipeline/known_faces.pkl`.  
+
+## 📝 License
+
+Distributed under the [MIT License](LICENSE).
+
+## 🙏 Acknowledgements
+
+- [Gradio](https://gradio.app/)
+- [YOLO](https://github.com/ultralytics/yolov5)
+- [FaceNet](https://github.com/timesler/facenet-pytorch)
+- [DeepSort](https://github.com/theAIGuysCode/deep_sort_realtime)
+- [Mediapipe](https://mediapipe.dev/)