Update README.md

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

456
README.md
View File

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