Update README.md

README.md

@@ -12,7 +12,38 @@ short_description: Trained model to recognize faces
 startup_duration_timeout: 2h
 ---
 
-explain a high-level overview of your code and how to run your code: 
-including what packages I must install, and 
-where the data came from and in which folder it must go.
+---
+license: mit
+---
+
+# Face Recognition Model
+"CSSE416-final-project/face-recognition" is the Hugging Face (HF) repository for the Face Recognition Application. It runs the HF faceRecogModel
+
+
+## Files
+- DS_Store
+- Arial Bold.ttf
+- app.py
+- celeb_indicies.py
+- dlib-19.24.99-cp310-cp310-linux_x86_64.whl
+- face_detection.py
+- requirements.txt
+
+## Datasource
+  - Upload your image via camera, clipboard (copy and pasting), or dragging and dropping a picture file into the UI
+  - For large scale testing, check out the model itself
+
+## Neccessary Package
+  - Since the model all runs on Hugging Face, you don't need to install any packages.
+  - However, if you do want to run the model locally, you will need to install these following packages:
+      - PIL
+      - gradio
+      - numpy
+      - diffusers
+      - torchvision
+      - huggingface_hub
+
+## Running
+  - The app runs the model out of the box by simple visiting the URL for the HF Space.
+  - Alternatively, if you want to test the model locally, you can download the repo and run "app.py"