README ready

.gitattributes

@@ -3,6 +3,7 @@
 *.ttf filter=lfs diff=lfs merge=lfs -text
 *.otf filter=lfs diff=lfs merge=lfs -text
 *.mp4 filter=lfs diff=lfs merge=lfs -text
+*.pdf filter=lfs diff=lfs merge=lfs -text
 
 *.7z filter=lfs diff=lfs merge=lfs -text
 *.arrow filter=lfs diff=lfs merge=lfs -text

README.md

@@ -11,4 +11,75 @@ license: mit
 short_description: AI-Powered Cover Letter Generator
 ---
 
-Hugging Face Space https://huggingface.co/spaces/cxumol/CoverPilot/
+<div align="center">
+  <div>&nbsp;</div>
+  <img src="asset/banner.png" width="400"/> 
+
+[Workflow](#how-it-works)|
+[Video](#demo)|
+[![Hugging Face](https://img.shields.io/badge/Demo-%F0%9F%A4%97%20Hugging%20Face-blue)](https://huggingface.co/spaces/cxumol/CoverPilot)|
+[How to Use](#setup)|
+![Visitors](https://api.infinitescript.com/badgen/count?name=cxumol/CoverPilot&ltext=Visitors)
+
+</div>
+
+CoverPilot is an AI-powered cover letter generator. It helps you focus on what matters most - getting the job.
+
+## How it works
+
+![workflow](asset/CoverPilot_workflow.png)
+
+## Demo
+
+How it actually works? Check out the demo video below.
+<video src="asset/CoverPilot_demo_h264_30fps_noaudio.mp4"></video>
+
+Try it on Hugging Face now! [![Hugging Face](https://img.shields.io/badge/Demo-%F0%9F%A4%97%20Hugging%20Face-blue)](https://huggingface.co/spaces/cxumol/CoverPilot)
+
+## Setup
+
+#### Prepare API for AI capabilities
+
+> [!IMPORTANT]
+> You have to bring your own API keys.  
+> If you have no idea about it, try getting one from https://beta.openai.com/account/api-keys
+
+The API base defaults to OpenAI's, and compatible with AI service providers who have the same API structure.
+
+Once you obtained can set API configurations in 2 ways:
+- environment variables
+- AI Setup panel on the Web UI
+
+Check out the [config.py](app/config.py) for more details.
+
+#### Deploy on Hugging Face
+
+[![🤗 Deploy on Hugging Face](https://huggingface.co/datasets/huggingface/badges/resolve/main/deploy-on-spaces-md-dark.svg)](https://huggingface.co/spaces/cxumol/CoverPilot?duplicate=true)
+
+#### Run on local
+
+```bash
+git clone https://github.com/cxumol/CoverPilot.git && cd CoverPilot
+pip install -r requirements.txt
+python app/app.py
+```
+
+Once the app is running, you can access it at http://localhost:7860.  
+And then follow the instructions on the Web UI.  
+
+If you are still confused about how to use it, check out the [demo video](#demo).
+
+## Example
+
+Here is an example of output pdf [cover_letter_by_Steve Jobs_to_Microsoft.pdf](asset/example_cover_letter_by_Steve Jobs_to_Microsoft.pdf).
+
+> [!TIP]
+> Yes, it's generated from the video demo.
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+## Motivation
+
+I'm looking for a job. Please consider hiring me if you like this project. 

asset/example_cover_letter_by_Steve Jobs_to_Microsoft.pdf

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:74346236c0bde6df83409e11735e11d9a8487de61bd1c7d07560aebe446267bb
+size 46952