diff --git a/README.md b/README.md index 56a9ab2..13dbe46 100644 --- a/README.md +++ b/README.md @@ -1 +1,31 @@ -# linkedinsummary \ No newline at end of file +# LinkedIn Profile Summary Generator + +This web application allows users to generate a summary of a LinkedIn profile and a brief summary of a company based on the company name provided. The summaries are generated using AI responses and displayed in HTML format. + +## Features +- Upload a LinkedIn profile PDF to generate a profile summary. +- Enter a company name to generate a company summary. +- Toggle between light, dark, and auto themes. +- Save the generated summary as a PDF. + +## Technologies Used +- HTML +- CSS +- JavaScript +- Bootstrap 5 +- Bootstrap Icons +- PDF.js +- html2pdf.js +- jspdf +- html2canvas + +## How to Use +1. Clone the repository. +2. Open the `index.html` file in a web browser. +3. Upload a LinkedIn profile PDF and enter a company name. +4. Click on "Generate Summary" to see the generated profile and company summaries. +5. Toggle between themes using the theme dropdown. +6. Click on "Save as PDF" to save the summary as a PDF file. + +## Authors +- Prudhvi - prudhvi.krovvidi@straive.com