Spaces:
Running
Running
update README
Browse files
README.md
CHANGED
@@ -11,34 +11,42 @@ license: mit
|
|
11 |
short_description: AI-Powered Cover Letter Generator
|
12 |
---
|
13 |
|
|
|
|
|
14 |
<div align="center">
|
15 |
<div> </div>
|
16 |
-
<img src="asset/banner.png" width="400"/>
|
17 |
|
18 |
-
|
19 |
-
|
20 |
-
|
21 |
-
[How to Use](#setup)|
|
22 |
-

|
23 |
|
24 |
-
</div>
|
25 |
|
26 |
CoverPilot is an AI-powered cover letter generator. It helps you focus on what matters most - getting the job.
|
27 |
|
28 |
-
|
|
|
|
|
29 |
|
30 |
-
|
31 |
|
32 |
## Demo
|
33 |
|
34 |
-
How it actually works? Check out the demo video below.
|
35 |
<video src="asset/CoverPilot_demo_h264_30fps_noaudio.mp4"></video>
|
36 |
|
37 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
38 |
|
39 |
## Setup
|
40 |
|
41 |
-
|
42 |
|
43 |
> [!IMPORTANT]
|
44 |
> You have to bring your own API keys.
|
@@ -52,11 +60,11 @@ Once you obtained can set API configurations in 2 ways:
|
|
52 |
|
53 |
Check out the [config.py](app/config.py) for more details.
|
54 |
|
55 |
-
|
56 |
|
57 |
[](https://huggingface.co/spaces/cxumol/CoverPilot?duplicate=true)
|
58 |
|
59 |
-
|
60 |
|
61 |
```bash
|
62 |
git clone https://github.com/cxumol/CoverPilot.git && cd CoverPilot
|
@@ -71,7 +79,7 @@ If you are still confused about how to use it, check out the [demo video](#demo)
|
|
71 |
|
72 |
## Example
|
73 |
|
74 |
-
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)
|
75 |
|
76 |
> [!TIP]
|
77 |
> Yes, it's generated from the video demo.
|
@@ -82,4 +90,4 @@ Pull requests are welcome. For major changes, please open an issue first to disc
|
|
82 |
|
83 |
## Motivation
|
84 |
|
85 |
-
|
|
|
11 |
short_description: AI-Powered Cover Letter Generator
|
12 |
---
|
13 |
|
14 |
+
---
|
15 |
+
|
16 |
<div align="center">
|
17 |
<div> </div>
|
|
|
18 |
|
19 |
+
<div> </div>
|
20 |
+
|
21 |
+
<img src="asset/banner.png" width="400"/>
|
|
|
|
|
22 |
|
|
|
23 |
|
24 |
CoverPilot is an AI-powered cover letter generator. It helps you focus on what matters most - getting the job.
|
25 |
|
26 |
+
[Watch process in action](#demo) |
|
27 |
+
[How it can help](#workflow) |
|
28 |
+
[Deploy your own](#setup)
|
29 |
|
30 |
+
</div>
|
31 |
|
32 |
## Demo
|
33 |
|
|
|
34 |
<video src="asset/CoverPilot_demo_h264_30fps_noaudio.mp4"></video>
|
35 |
|
36 |
+
https://github.com/cxumol/CoverPilot/assets/8279655/fe66bc9a-8d05-4f69-b3f5-b48f66464993
|
37 |
+
|
38 |
+
- Try it on Hugging Face now! [](https://huggingface.co/spaces/cxumol/CoverPilot)
|
39 |
+
|
40 |
+
## Workflow
|
41 |
+
|
42 |
+
With the power of Prompt Engineering, CoverPilot can deeply understand your resume and the job description, and find the best writing style to match your resume with the job. The following flow graph illustrates how CoverPilot works.
|
43 |
+
|
44 |
+

|
45 |
+
|
46 |
|
47 |
## Setup
|
48 |
|
49 |
+
### Prepare API for AI capabilities
|
50 |
|
51 |
> [!IMPORTANT]
|
52 |
> You have to bring your own API keys.
|
|
|
60 |
|
61 |
Check out the [config.py](app/config.py) for more details.
|
62 |
|
63 |
+
### Deploy on Hugging Face
|
64 |
|
65 |
[](https://huggingface.co/spaces/cxumol/CoverPilot?duplicate=true)
|
66 |
|
67 |
+
### Run on local
|
68 |
|
69 |
```bash
|
70 |
git clone https://github.com/cxumol/CoverPilot.git && cd CoverPilot
|
|
|
79 |
|
80 |
## Example
|
81 |
|
82 |
+
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)
|
83 |
|
84 |
> [!TIP]
|
85 |
> Yes, it's generated from the video demo.
|
|
|
90 |
|
91 |
## Motivation
|
92 |
|
93 |
+
Please consider hiring me if you like this project.
|