peisongxiao/wwcompanion
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

updated README

Browse Source
This commit is contained in:
Peisong Xiao
2026-01-17 18:57:07 -05:00
parent d49c33268a
commit 605cd93aa6
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@@ -15,7 +15,7 @@ LLM-enabled AI companionship with WaterlooWorks job postings.
## Usage ## Usage
- Load the extension into a Chromium-based browser (root directory at [wwcompanion-extension](wwcompanion-extension/)) - Load the extension into a Chromium-based browser (root directory at [wwcompanion-extension](wwcompanion-extension/))
- Configure API settings, prompts, and tasks in **Settings**. - Configure API settings, prompts, your profiles, and tasks in **Settings**.
- Open a WaterlooWorks job posting modal. - Open a WaterlooWorks job posting modal.
- Click **Run** in the popup to extract the posting text and run the task. - Click **Run** in the popup to extract the posting text and run the task.
- Review the streamed response, then copy or clear it as needed. - Review the streamed response, then copy or clear it as needed.
@@ -26,6 +26,7 @@ LLM-enabled AI companionship with WaterlooWorks job postings.
- Add your API key, base URL, and model (defaults target - Add your API key, base URL, and model (defaults target
OpenAI-compatible APIs). OpenAI-compatible APIs).
- Set your system prompt in environments and resume text. - Set your system prompt in environments and resume text.
- Set your profile with text from your resume or a profile description text.
- Customize task presets; **the top task is used as the default**. - Customize task presets; **the top task is used as the default**.
## Example prompts ## Example prompts