martin/linkedIn_auto_jobs_applier_with_AI
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Federico 2024-08-23 22:52:54 +01:00 committed by GitHub
parent 3bc6a89364
commit 7c508f5822
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 209 additions and 247 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

308
README.md
View File

@ -174,26 +174,22 @@ This file contains your resume information in a structured format. Fill it out w
Each section has specific fields to fill out: Each section has specific fields to fill out:
#### Personal Information - Personal Information
- This section contains basic personal details to identify yourself and provide contact information.
##### Description - **name**: Your first name.
This section contains basic personal details to identify yourself and provide contact information. - **surname**: Your last name or family name.
- **date_of_birth**: Your birth date in the format DD/MM/YYYY.
- **name**: Your first name. - **country**: The country where you currently reside.
- **surname**: Your last name or family name. - **city**: The city where you currently live.
- **date_of_birth**: Your birth date in the format DD/MM/YYYY. - **address**: Your full address, including street and number.
- **country**: The country where you currently reside. - **phone_prefix**: The international dialing code for your phone number (e.g., +1 for the USA, +44 for the UK).
- **city**: The city where you currently live. - **phone**: Your phone number without the international prefix.
- **address**: Your full address, including street and number. - **email**: Your primary email address.
- **phone_prefix**: The international dialing code for your phone number (e.g., +1 for the USA, +44 for the UK). - **github**: URL to your GitHub profile, if applicable.
- **phone**: Your phone number without the international prefix. - **linkedin**: URL to your LinkedIn profile, if applicable.
- **email**: Your primary email address. - Example
- **github**: URL to your GitHub profile, if applicable. ```yaml
- **linkedin**: URL to your LinkedIn profile, if applicable. personal_information:
##### Example
```yaml
personal_information:
name: "Jane" name: "Jane"
surname: "Doe" surname: "Doe"
date_of_birth: "01/01/1990" date_of_birth: "01/01/1990"
@ -205,23 +201,20 @@ personal_information:
email: "jane.doe@example.com" email: "jane.doe@example.com"
github: "https://github.com/janedoe" github: "https://github.com/janedoe"
linkedin: "https://www.linkedin.com/in/janedoe/" linkedin: "https://www.linkedin.com/in/janedoe/"
``` ```
#### Education Details - Education Details
- This section outlines your academic background, including degrees earned and relevant coursework.
- **degree**: The type of degree obtained (e.g., Bachelor's Degree, Master's Degree).
- **university**: The name of the university or institution where you studied.
- **gpa**: Your Grade Point Average or equivalent measure of academic performance.
- **graduation_year**: The year you graduated.
- **field_of_study**: The major or focus area of your studies.
- **exam**: A list of courses or subjects taken along with their respective grades.
##### Description - Example:
This section outlines your academic background, including degrees earned and relevant coursework. ```yaml
education_details:
- **degree**: The type of degree obtained (e.g., Bachelor's Degree, Master's Degree).
- **university**: The name of the university or institution where you studied.
- **gpa**: Your Grade Point Average or equivalent measure of academic performance.
- **graduation_year**: The year you graduated.
- **field_of_study**: The major or focus area of your studies.
- **exam**: A list of courses or subjects taken along with their respective grades.
##### Example
```yaml
education_details:
- degree: "Bachelor's Degree" - degree: "Bachelor's Degree"
university: "University of Example" university: "University of Example"
gpa: "3.8/4" gpa: "3.8/4"
@ -233,188 +226,161 @@ education_details:
Database Systems: "A" Database Systems: "A"
Operating Systems: "A-" Operating Systems: "A-"
Web Development: "B" Web Development: "B"
``` ```
#### Experience Details - Experience Details
##### Description - This section details your work experience, including job roles, companies, and key responsibilities.
This section details your work experience, including job roles, companies, and key responsibilities. - **position**: Your job title or role.
- **company**: The name of the company or organization where you worked.
- **employment_period**: The timeframe during which you were employed in the role (e.g., MM/YYYY - MM/YYYY).
- **location**: The city and country where the company is located.
- **industry**: The industry or field in which the company operates.
- **key_responsibilities**: A list of major responsibilities or duties you had in the role.
- **skills_acquired**: Skills or expertise gained through this role.
- **position**: Your job title or role. - Example:
- **company**: The name of the company or organization where you worked. ```yaml
- **employment_period**: The timeframe during which you were employed in the role (e.g., MM/YYYY - MM/YYYY). experience_details:
- **location**: The city and country where the company is located.
- **industry**: The industry or field in which the company operates.
- **key_responsibilities**: A list of major responsibilities or duties you had in the role.
- **skills_acquired**: Skills or expertise gained through this role.
##### Example
```yaml
experience_details:
- position: "Software Developer" - position: "Software Developer"
company: "Tech Innovations Inc." company: "Tech Innovations Inc."
employment_period: "06/2021 - Present" employment_period: "06/2021 - Present"
location: "San Francisco, CA" location: "San Francisco, CA"
industry: "Technology" industry: "Technology"
key_responsibilities: key_responsibilities:
- responsibility_1: "Developed web applications using React and Node.js" - "Developed web applications using React and Node.js"
- responsibility_2: "Collaborated with cross-functional teams to design and implement new features" - "Collaborated with cross-functional teams to design and implement new features"
- responsibility_3: "Troubleshot and resolved complex software issues" - "Troubleshot and resolved complex software issues"
skills_acquired: skills_acquired:
- "React" - "React"
- "Node.js" - "Node.js"
- "Software Troubleshooting" - "Software Troubleshooting"
``` ```
#### Projects - Projects
- Include notable projects you have worked on, including personal or professional projects.
- **name**: The name or title of the project.
- **description**: A brief summary of what the project involves or its purpose.
- **link**: URL to the project, if available (e.g., GitHub repository, website).
##### Description - Example:
Include notable projects you have worked on, including personal or professional projects. ```yaml
projects:
- **name**: The name or title of the project.
- **description**: A brief summary of what the project involves or its purpose.
- **link**: URL to the project, if available (e.g., GitHub repository, website).
##### Example
```yaml
projects:
- name: "Weather App" - name: "Weather App"
description: "A web application that provides real-time weather information using a third-party API." description: "A web application that provides real-time weather information using a third-party API."
link: "https://github.com/janedoe/weather-app" link: "https://github.com/janedoe/weather-app"
- name: "Task Manager" - name: "Task Manager"
description: "A task management tool with features for tracking and prioritizing tasks." description: "A task management tool with features for tracking and prioritizing tasks."
link: "https://github.com/janedoe/task-manager" link: "https://github.com/janedoe/task-manager"
``` ```
#### Achievements - Achievements
- Highlight notable accomplishments or awards you have received.
- **name**: The title or name of the achievement.
- **description**: A brief explanation of the achievement and its significance.
##### Description - Example:
Highlight notable accomplishments or awards you have received. ```yaml
achievements:
- **name**: The title or name of the achievement.
- **description**: A brief explanation of the achievement and its significance.
##### Example
```yaml
achievements:
- name: "Employee of the Month" - name: "Employee of the Month"
description: "Recognized for exceptional performance and contributions to the team." description: "Recognized for exceptional performance and contributions to the team."
- name: "Hackathon Winner" - name: "Hackathon Winner"
description: "Won first place in a national hackathon competition." description: "Won first place in a national hackathon competition."
``` ```
#### Certifications - Certifications
- Include any professional certifications you have earned.
- **certification_name**: The name of the certification.
##### Description - Example:
Include any professional certifications you have earned. ```yaml
certifications:
- **certification_name**: The name of the certification.
##### Example
```yaml
certifications:
- "Certified Scrum Master" - "Certified Scrum Master"
- "AWS Certified Solutions Architect" - "AWS Certified Solutions Architect"
``` ```
#### Languages - Languages
- Detail the languages you speak and your proficiency level in each.
- **language**: The name of the language.
- **proficiency**: Your level of proficiency (e.g., Native, Fluent, Intermediate).
##### Description - Example:
Detail the languages you speak and your proficiency level in each. ```yaml
languages:
- **language**: The name of the language.
- **proficiency**: Your level of proficiency (e.g., Native, Fluent, Intermediate).
##### Example
```yaml
languages:
- language: "English" - language: "English"
proficiency: "Fluent" proficiency: "Fluent"
- language: "Spanish" - language: "Spanish"
proficiency: "Intermediate" proficiency: "Intermediate"
``` ```
#### Interests - Interests
##### Description - Mention your professional or personal interests that may be relevant to your career.
Mention your professional or personal interests that may be relevant to your career. - **interest**: A list of interests or hobbies.
- **interest**: A list of interests or hobbies. - Example:
```yaml
##### Example interests:
```yaml
interests:
- "Machine Learning" - "Machine Learning"
- "Cybersecurity" - "Cybersecurity"
- "Open Source Projects" - "Open Source Projects"
- "Digital Marketing" - "Digital Marketing"
- "Entrepreneurship" - "Entrepreneurship"
``` ```
#### Availability - Availability
- State your current availability or notice period.
- **notice_period**: The amount of time required before you can start a new role (e.g., "2 weeks", "1 month").
##### Description - Example:
State your current availability or notice period. ```yaml
availability:
- **notice_period**: The amount of time required before you can start a new role (e.g., "2 weeks", "1 month").
##### Example
```yaml
availability:
notice_period: "2 weeks" notice_period: "2 weeks"
``` ```
#### Salary Expectations - Salary Expectations
- Provide your expected salary range.
- **salary_range_usd**: The salary range you are expecting, expressed in USD.
##### Description - Example:
Provide your expected salary range. ```yaml
salary_expectations:
- **salary_range_usd**: The salary range you are expecting, expressed in USD.
##### Example
```yaml
salary_expectations:
salary_range_usd: "80000 - 100000" salary_range_usd: "80000 - 100000"
``` ```
#### Self-Identification - Self-Identification
- Provide information related to personal identity, including gender and pronouns.
- **gender**: Your gender identity.
- **pronouns**: The pronouns you use (e.g., He/Him, She/Her, They/Them).
- **veteran**: Your status as a veteran (e.g., Yes, No).
- **disability**: Whether you have a disability (e.g., Yes, No).
- **ethnicity**: Your ethnicity.
##### Description - Example:
Provide information related to personal identity, including gender and pronouns. ```yaml
self_identification:
- **gender**: Your gender identity.
- **pronouns**: The pronouns you use (e.g., He/Him, She/Her, They/Them).
- **veteran**: Your status as a veteran (e.g., Yes, No).
- **disability**: Whether you have a disability (e.g., Yes, No).
- **ethnicity**: Your ethnicity.
##### Example
```yaml
self_identification:
gender: "Female" gender: "Female"
pronouns: "She/Her" pronouns: "She/Her"
veteran: "No" veteran: "No"
disability: "No" disability: "No"
ethnicity: "Asian" ethnicity: "Asian"
``` ```
#### Legal Authorization - Legal Authorization
##### Description - Indicate your legal ability to work in various locations.
Indicate your legal ability to work in various locations. - **eu_work_authorization**: Whether you are authorized to work in the European Union (Yes/No).
- **us_work_authorization**: Whether you are authorized to work in the United States (Yes/No).
- **requires_us_visa**: Whether you require a visa to work in the US (Yes/No).
- **requires_us_sponsorship**: Whether you require sponsorship to work in the US (Yes/No).
- **requires_eu_visa**: Whether you require a visa to work in the EU (Yes/No).
- **legally_allowed_to_work_in_eu**: Whether you are legally allowed to work in the EU (Yes/No).
- **legally_allowed_to_work_in_us**: Whether you are legally allowed to work in the US (Yes/No).
- **requires_eu_sponsorship**: Whether you require sponsorship to work in the EU (Yes/No).
- **eu_work_authorization**: Whether you are authorized to work in the European Union (Yes/No). - Example:
- **us_work_authorization**: Whether you are authorized to work in the United States (Yes/No). ```yaml
- **requires_us_visa**: Whether you require a visa to work in the US (Yes/No). legal_authorization:
- **requires_us_sponsorship**: Whether you require sponsorship to work in the US (Yes/No).
- **requires_eu_visa**: Whether you require a visa to work in the EU (Yes/No).
- **legally_allowed_to_work_in_eu**: Whether you are legally allowed to work in the EU (Yes/No).
- **legally_allowed_to_work_in_us**: Whether you are legally allowed to work in the US (Yes/No).
- **requires_eu_sponsorship**: Whether you require sponsorship to work in the EU (Yes/No).
##### Example
```yaml
legal_authorization:
eu_work_authorization: "Yes" eu_work_authorization: "Yes"
us_work_authorization: "No" us_work_authorization: "No"
requires_us_visa: "Yes" requires_us_visa: "Yes"
@ -423,32 +389,28 @@ legal_authorization:
legally_allowed_to_work_in_eu: "Yes" legally_allowed_to_work_in_eu: "Yes"
legally_allowed_to_work_in_us: "No" legally_allowed_to_work_in_us: "No"
requires_eu_sponsorship: "No" requires_eu_sponsorship: "No"
``` ```
#### Work Preferences - Work Preferences
##### Description - Specify your preferences for work arrangements and conditions.
Specify your preferences for work arrangements and conditions. - **remote_work**: Whether you are open to remote work (Yes/No).
- **in_person_work**: Whether you are open to in-person work (Yes/No).
- **open_to_relocation**: Whether you are willing to relocate for a job (Yes/No).
- **willing_to_complete_assessments**: Whether you are willing to complete job assessments (Yes/No).
- **willing_to_undergo_drug_tests**: Whether you are willing to undergo drug testing (Yes/No).
- **willing_to_undergo_background_checks**: Whether you are willing to undergo background checks (Yes/No).
- **remote_work**: Whether you are open to remote work (Yes/No). - Example:
- **in_person_work**: Whether you are open to in-person work (Yes/No). ```yaml
- **open_to_relocation**: Whether you are willing to relocate for a job (Yes/No). work_preferences:
- **willing_to_complete_assessments**: Whether you are willing to complete job assessments (Yes/No).
- **willing_to_undergo_drug_tests**: Whether you are willing to undergo drug testing (Yes/No).
- **willing_to_undergo_background_checks**: Whether you are willing to undergo background checks (Yes/No).
##### Example
```yaml
work
_preferences:
remote_work: "Yes" remote_work: "Yes"
in_person_work: "No" in_person_work: "No"
open_to_relocation: "Yes" open_to_relocation: "Yes"
willing_to_complete_assessments: "Yes" willing_to_complete_assessments: "Yes"
willing_to_undergo_drug_tests: "No" willing_to_undergo_drug_tests: "No"
willing_to_undergo_background_checks: "Yes" willing_to_undergo_background_checks: "Yes"
``` ```
### PLUS. data_folder_example ### PLUS. data_folder_example