Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #1

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 0 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1 @@
# Cover Letter Generator

This project generates a cover letter PDF based on a template and user inputs.

## Features
- Replace placeholders in the template with user-provided values.
- Generate a well-formatted PDF.
- Chrome extension popup interface.

## Installation
1. Clone the repository.
2. Load the extension in Chrome:
- Go to `chrome://extensions/`.
- Enable "Developer mode".
- Click "Load unpacked" and select the project folder.

## Usage
1. Open the Chrome extension popup.
2. Enter the company name, position, and location.
3. Click "Convert to PDF" to generate the cover letter PDF.

## Development
- Ensure you have the latest versions of dependencies.
- Run tests using Jest.

## License
This project is licensed under the MIT License.