add readme

README.md

@@ -1,10 +1,44 @@
----
-title: Api Ta
-emoji: 🏢
-colorFrom: pink
-colorTo: red
-sdk: docker
-pinned: false
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Playground
+
+- https://mrfirdauss-api-ta.hf.space/docs
+- Resume examples: https://resumecat.com/resume-examples
+- Demo video:
+
+[![Demo video](https://i9.ytimg.com/vi_webp/toO0OwvWPNc/mq2.webp?sqp=CPDogr0G-oaymwEmCMACELQB8quKqQMa8AEB-AHUBoAC4AOKAgwIABABGGUgZShlMA8=&rs=AOn4CLAdmZZGDuoicf6-KCeHKxB1tzspuA)](https://www.youtube.com/watch?v=toO0OwvWPNc)
+
+
+# Running locally
+
+Follow the instructions at:
+
+https://huggingface.co/spaces/mrfirdauss/api-ta?docker=true
+
+
+# Development setup
+
+```
+git clone [email protected]:rekrutmen_plus/modul-extractor.git
+```
+Then:
+
+## Option 1: With Docker
+```
+cd modul-extractor
+docker build -t modul-extractor .
+docker run -p 7860:7860 modul-extractor
+```
+Then open: `http://localhost:7860/docs`
+
+## Option 2: Without Docker
+- [Install git-lfs](https://github.com/git-lfs/git-lfs?tab=readme-ov-file#installing), then:
+
+```
+cd modul-extractor
+git lfs install
+pip install -r requirements.txt
+uvicorn app:app --host 0.0.0.0 --port 7860
+```
+Then open: `http://localhost:7860/docs`
+
+
+