Create README.md

README.md

@@ -1,25 +1,34 @@
-#this gets the repo
-git clone repo 
-
-#this gets up to date code
-git pull
-
-#this creates a branch which you can work on
-git checkout -b "djo/your-branch-description"
-
-#this installs everything you need
-npm i
-
-#this gives you secrets
-get .env file from DJ or put secrets in manually into .env file which you create
-
-##VERY IMPORTANT
-make sure you create a git ignore file (ask chatgpt if you have never done this before) which ignores your .env file
-
-#this runs the program
-node autotag-pdf.js
-
-#creates a branch with your changes
-git push 
-
-#we can review pull requests as a team to identify if things are  good for merge.
+---
+title: PowerPoint Accessibility Analyzer
+emoji: 🚀
+colorFrom: blue
+colorTo: green
+sdk: docker
+pinned: false
+---
+
+# Accessibility PowerPoint Analyzer (Backend)
+
+This is the backend for the Accessibility PowerPoint Analyzer, built with FastAPI. It processes `.pptx` files to identify and remediate accessibility issues, including generating AI alt-text for images using local vision models.
+
+## 🌟 Features
+- **FastAPI Backend:** Handles file uploads and processing asynchronously.
+- **Local AI Vision:** Uses BLIP/GIT models via `transformers` to generate alt-text for free.
+- **CORS Enabled:** Configured to communicate with the Vercel frontend.
+- **Automatic Remediation:** Fixes color contrast and missing titles.
+
+## 🛠 Tech Stack
+- **Language:** Python 3.10+
+- **Framework:** FastAPI
+- **Libraries:** `python-pptx`, `torch`, `transformers`, `lxml`
+- **Deployment:** Docker on Hugging Face Spaces
+
+## 🚀 How to use
+The frontend (deployed on Vercel) sends requests to this Space's endpoint. 
+
+For local testing:
+1. Install dependencies: `pip install -r requirements.txt`
+2. Run the server: `python app.py`
+
+## 📄 License
+This project was developed as part of a technical coursework/senior project focused on accessibility tools.