diff --git a/README.md b/README.md index 010235b..0020837 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,28 @@ A Python package for ingesting job descriptions & resumes, and crafting cover letters that use the latter to satisfy the former. +The process leverages GPT-4 to first extract relevant job description features, grabbing +corresponding features from the resume, and then looping between (1) generating a cover letter that +uses the resume to satisfy the job description and (2) critiquing the cover letter in question. +A state diagram follows: + +```mermaid +stateDiagram-v2 + direction TB + state "Extract key requirements" as JD_Extract + state "Pull relevant item from resume" as Resume + state "Write a cover letter draft" as Write + state "Review and get feedback on draft" as Review + [*] --> JD_Extract + JD_Extract --> Resume + Resume --> Draft + state Draft { + Review --> Write + Write --> Review + } + Draft --> [*] +``` + ## 🚀 Using ### With PyPi install @@ -17,7 +39,7 @@ This should make `make-cover-letter` command available on your command line. You following: ```bash -make-cover-letter --resume path/to/json/resume.json --jd path/to/jd.md +make-cover-letter path/to/json/resume.json path/to/jd.md ``` This will generate a cover letter for the job description in `path/to/jd.md` using the resume in