final
This commit is contained in:
parent
b85a3c4719
commit
08fa73c8de
11 changed files with 570 additions and 186 deletions
317
README.md
317
README.md
|
|
@ -175,55 +175,281 @@ This file contains your resume information in a structured format. Fill it out w
|
|||
|
||||
Each section has specific fields to fill out:
|
||||
|
||||
- `personal_information:`
|
||||
- Contains basic personal details
|
||||
- Example: `name: "John Doe"`
|
||||
#### Personal Information
|
||||
|
||||
- `self_identification:`
|
||||
- Optional demographic information
|
||||
- Example: `gender: "Male"`
|
||||
##### Description
|
||||
This section contains basic personal details to identify yourself and provide contact information.
|
||||
|
||||
- `legal_authorization:`
|
||||
- Work authorization status
|
||||
- Use `true` or `false` for each field
|
||||
- Example: `usWorkAuthorization: true`
|
||||
- **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.
|
||||
|
||||
- `work_preferences:`
|
||||
- Your work-related preferences
|
||||
- Use `true` or `false` for each field
|
||||
- Example: `remoteWork: true`
|
||||
##### 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/"
|
||||
```
|
||||
|
||||
- `education_details:`
|
||||
- List your educational background
|
||||
- Include degree, university, GPA, graduation year, field of study, and skills acquired
|
||||
- Example:
|
||||
```yaml
|
||||
- degree: "Bachelor's"
|
||||
university: "University of Example"
|
||||
gpa: "3.8"
|
||||
graduationYear: "2022"
|
||||
fieldOfStudy: "Computer Science"
|
||||
skillsAcquired:
|
||||
problemSolving: "4"
|
||||
```
|
||||
#### Education Details
|
||||
|
||||
- `experience_details:`
|
||||
- List your work experiences
|
||||
- Include position, company, employment period, location, industry, key responsibilities, and skills acquired
|
||||
- Example:
|
||||
```yaml
|
||||
- position: "Software Developer"
|
||||
company: "Tech Corp"
|
||||
employmentPeriod: "Jan 2020 - Present"
|
||||
location: "San Francisco, USA"
|
||||
industry: "Technology"
|
||||
keyResponsibilities:
|
||||
responsibility1: "Developed web applications using React"
|
||||
skillsAcquired:
|
||||
adaptability: "3"
|
||||
```
|
||||
##### Description
|
||||
This section outlines your academic background, including degrees earned and relevant coursework.
|
||||
|
||||
- Other sections like `projects`, `availability`, `salary_expectations`, `certifications`, `skills`, `languages`, and `interests` follow a similar format, with each item on a new line.
|
||||
- **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"
|
||||
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"
|
||||
```
|
||||
|
||||
#### Experience Details
|
||||
|
||||
##### Description
|
||||
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.
|
||||
|
||||
##### 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"
|
||||
```
|
||||
|
||||
#### Projects
|
||||
|
||||
##### Description
|
||||
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
|
||||
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
|
||||
|
||||
##### Description
|
||||
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.
|
||||
|
||||
##### 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."
|
||||
```
|
||||
|
||||
#### Certifications
|
||||
|
||||
##### Description
|
||||
Include any professional certifications you have earned.
|
||||
|
||||
- **certification_name**: The name of the certification.
|
||||
|
||||
##### Example
|
||||
```yaml
|
||||
certifications:
|
||||
- "Certified Scrum Master"
|
||||
- "AWS Certified Solutions Architect"
|
||||
```
|
||||
|
||||
#### Languages
|
||||
|
||||
##### Description
|
||||
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).
|
||||
|
||||
##### Example
|
||||
```yaml
|
||||
languages:
|
||||
- language: "English"
|
||||
proficiency: "Fluent"
|
||||
- language: "Spanish"
|
||||
proficiency: "Intermediate"
|
||||
```
|
||||
|
||||
#### 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"
|
||||
```
|
||||
|
||||
### PLUS. data_folder_example
|
||||
|
||||
|
|
@ -247,7 +473,6 @@ Using this folder as a guide can be particularly helpful for:
|
|||
2. Seeing examples of valid data for each field
|
||||
3. Having a reference point while filling out your personal files
|
||||
|
||||
#### Important Note
|
||||
|
||||
## Usage
|
||||
0. **LinkedIn language**
|
||||
|
|
@ -276,7 +501,7 @@ Using this folder as a guide can be particularly helpful for:
|
|||
|
||||
## Documentation
|
||||
|
||||
For detailed information on each component and their respective roles, please refer to the [Documentation](documentation.md) file.
|
||||
TODO ):
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
|
@ -292,7 +517,7 @@ LinkedIn_AIHawk provides a significant advantage in the modern job market by aut
|
|||
|
||||
## Contributors
|
||||
|
||||
- [feder-cr](https://github.com/feder-cr/) - Creator and Maintainer
|
||||
- [feder-cr](https://github.com/feder-cr) - Creator and Lead Developer
|
||||
|
||||
LinkedIn_AIHawk is still in beta, and your feedback, suggestions, and contributions are highly valued. Feel free to open issues, suggest enhancements, or submit pull requests to help improve the project. Let's work together to make LinkedIn_AIHawk an even more powerful tool for job seekers worldwide.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue