Update README.md
This commit is contained in:
parent
3bc6a89364
commit
7c508f5822
456
README.md
456
README.md
@ -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:
|
||||
|
||||
#### 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
|
||||
This section contains basic personal details to identify yourself and provide contact information.
|
||||
- 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.
|
||||
|
||||
- **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
|
||||
education_details:
|
||||
- degree: "Bachelor's Degree"
|
||||
university: "University of Example"
|
||||
gpa: "3.8/4"
|
||||
graduation_year: "2022"
|
||||
field_of_study: "Software Engineering"
|
||||
exam:
|
||||
Algorithms: "A"
|
||||
Data Structures: "B+"
|
||||
Database Systems: "A"
|
||||
Operating Systems: "A-"
|
||||
Web Development: "B"
|
||||
```
|
||||
|
||||
##### 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/"
|
||||
```
|
||||
- Experience Details
|
||||
|
||||
#### 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
|
||||
This section outlines your academic background, including degrees earned and relevant coursework.
|
||||
- Example:
|
||||
```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).
|
||||
- **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.
|
||||
- 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).
|
||||
|
||||
##### Example
|
||||
```yaml
|
||||
education_details:
|
||||
- degree: "Bachelor's Degree"
|
||||
university: "University of Example"
|
||||
gpa: "3.8/4"
|
||||
graduation_year: "2022"
|
||||
field_of_study: "Software Engineering"
|
||||
exam:
|
||||
Algorithms: "A"
|
||||
Data Structures: "B+"
|
||||
Database Systems: "A"
|
||||
Operating Systems: "A-"
|
||||
Web Development: "B"
|
||||
```
|
||||
- Example:
|
||||
```yaml
|
||||
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"
|
||||
```
|
||||
|
||||
#### 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
|
||||
This section details your work experience, including job roles, companies, and key responsibilities.
|
||||
- Example:
|
||||
```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.
|
||||
- **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.
|
||||
- Certifications
|
||||
- Include any professional certifications you have earned.
|
||||
- **certification_name**: The name of the certification.
|
||||
|
||||
##### Example
|
||||
```yaml
|
||||
experience_details:
|
||||
- position: "Software Developer"
|
||||
company: "Tech Innovations Inc."
|
||||
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"
|
||||
```
|
||||
- Example:
|
||||
```yaml
|
||||
certifications:
|
||||
- "Certified Scrum Master"
|
||||
- "AWS Certified Solutions Architect"
|
||||
```
|
||||
|
||||
#### 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
|
||||
Include notable projects you have worked on, including personal or professional projects.
|
||||
- Example:
|
||||
```yaml
|
||||
languages:
|
||||
- language: "English"
|
||||
proficiency: "Fluent"
|
||||
- language: "Spanish"
|
||||
proficiency: "Intermediate"
|
||||
```
|
||||
|
||||
- **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).
|
||||
- Interests
|
||||
|
||||
##### Example
|
||||
```yaml
|
||||
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"
|
||||
```
|
||||
- Mention your professional or personal interests that may be relevant to your career.
|
||||
- **interest**: A list of interests or hobbies.
|
||||
|
||||
#### Achievements
|
||||
- Example:
|
||||
```yaml
|
||||
interests:
|
||||
- "Machine Learning"
|
||||
- "Cybersecurity"
|
||||
- "Open Source Projects"
|
||||
- "Digital Marketing"
|
||||
- "Entrepreneurship"
|
||||
```
|
||||
|
||||
##### Description
|
||||
Highlight notable accomplishments or awards you have received.
|
||||
- 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").
|
||||
|
||||
- **name**: The title or name of the achievement.
|
||||
- **description**: A brief explanation of the achievement and its significance.
|
||||
- Example:
|
||||
```yaml
|
||||
availability:
|
||||
notice_period: "2 weeks"
|
||||
```
|
||||
|
||||
##### Example
|
||||
```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."
|
||||
```
|
||||
- Salary Expectations
|
||||
- Provide your expected salary range.
|
||||
- **salary_range_usd**: The salary range you are expecting, expressed in USD.
|
||||
|
||||
#### Certifications
|
||||
- Example:
|
||||
```yaml
|
||||
salary_expectations:
|
||||
salary_range_usd: "80000 - 100000"
|
||||
```
|
||||
|
||||
##### Description
|
||||
Include any professional certifications you have earned.
|
||||
- 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.
|
||||
|
||||
- **certification_name**: The name of the certification.
|
||||
- Example:
|
||||
```yaml
|
||||
self_identification:
|
||||
gender: "Female"
|
||||
pronouns: "She/Her"
|
||||
veteran: "No"
|
||||
disability: "No"
|
||||
ethnicity: "Asian"
|
||||
```
|
||||
|
||||
##### Example
|
||||
```yaml
|
||||
certifications:
|
||||
- "Certified Scrum Master"
|
||||
- "AWS Certified Solutions Architect"
|
||||
```
|
||||
- Legal Authorization
|
||||
|
||||
#### 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
|
||||
Detail the languages you speak and your proficiency level in each.
|
||||
- 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"
|
||||
```
|
||||
|
||||
- **language**: The name of the language.
|
||||
- **proficiency**: Your level of proficiency (e.g., Native, Fluent, Intermediate).
|
||||
- Work Preferences
|
||||
|
||||
##### Example
|
||||
```yaml
|
||||
languages:
|
||||
- language: "English"
|
||||
proficiency: "Fluent"
|
||||
- language: "Spanish"
|
||||
proficiency: "Intermediate"
|
||||
```
|
||||
- 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).
|
||||
|
||||
#### Interests
|
||||
|
||||
##### Description
|
||||
Mention your professional or personal interests that may be relevant to your career.
|
||||
|
||||
- **interest**: A list of interests or hobbies.
|
||||
|
||||
##### Example
|
||||
```yaml
|
||||
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"
|
||||
```
|
||||
- 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
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user