Update README.md

2024-08-23 22:52:54 +01:00 · 2024-08-23 22:52:54 +01:00 · 7c508f5822
commit 7c508f5822
parent 3bc6a89364
1 changed files with 209 additions and 247 deletions
--- a/README.md
+++ b/README.md
@ -174,11 +174,8 @@ This file contains your resume information in a structured format. Fill it out w

 Each section has specific fields to fill out:

-#### Personal Information
-
-##### Description
-This section contains basic personal details to identify yourself and provide contact 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.
@ -190,8 +187,7 @@ This section contains basic personal details to identify yourself and provide co
    - **email**: Your primary email address.
    - **github**: URL to your GitHub profile, if applicable.
    - **linkedin**: URL to your LinkedIn profile, if applicable.
-
-##### Example
+  - Example
  ```yaml
  personal_information:
    name: "Jane"
@ -207,11 +203,8 @@ personal_information:
    linkedin: "https://www.linkedin.com/in/janedoe/"
  ```

-#### Education Details
-
-##### Description
-This section outlines your academic background, including degrees earned and relevant coursework.
-
+- 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.
@ -219,7 +212,7 @@ This section outlines your academic background, including degrees earned and rel
    - **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
+  - Example:
  ```yaml
  education_details:
    - degree: "Bachelor's Degree"
@ -235,11 +228,9 @@ education_details:
        Web Development: "B"
  ```

-#### Experience Details
-
-##### Description
-This section details your work experience, including job roles, companies, and key responsibilities.
+- Experience 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).
@ -248,7 +239,7 @@ This section details your work experience, including job roles, companies, and k
    - **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
  experience_details:
    - position: "Software Developer"
@ -257,25 +248,22 @@ experience_details:
      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"
+        - "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"
  ```

-#### Projects
-
-##### Description
-Include notable projects you have worked on, including personal or professional 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).

-##### Example
+   - Example:
    ```yaml
    projects:
      - name: "Weather App"
@ -286,15 +274,12 @@ projects:
        link: "https://github.com/janedoe/task-manager"
    ```

-#### Achievements
-
-##### Description
-Highlight notable accomplishments or awards you have received.
-
+- 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.

-##### Example
+  - Example:
  ```yaml
  achievements:
    - name: "Employee of the Month"
@ -303,29 +288,23 @@ achievements:
      description: "Won first place in a national hackathon competition."
  ```

-#### Certifications
-
-##### Description
-Include any professional certifications you have earned.
-
+- Certifications
+  - Include any professional certifications you have earned.
    - **certification_name**: The name of the certification.

-##### Example
+  - Example:
  ```yaml
  certifications:
    - "Certified Scrum Master"
    - "AWS Certified Solutions Architect"
  ```

-#### Languages
-
-##### Description
-Detail the languages you speak and your proficiency level in each.
-
+- 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).

-##### Example
+  - Example:
  ```yaml
  languages:
    - language: "English"
@ -334,14 +313,12 @@ languages:
      proficiency: "Intermediate"
  ```

-#### Interests
-
-##### Description
-Mention your professional or personal interests that may be relevant to your career.
+- Interests

+  - Mention your professional or personal interests that may be relevant to your career.
    - **interest**: A list of interests or hobbies.

-##### Example
+  - Example:
  ```yaml
  interests:
    - "Machine Learning"
@ -351,44 +328,35 @@ interests:
    - "Entrepreneurship"
  ```

-#### Availability
-
-##### Description
-State your current availability or notice period.
-
+- 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").

-##### Example
+  - Example:
  ```yaml
  availability:
    notice_period: "2 weeks"
  ```

-#### Salary Expectations
-
-##### Description
-Provide your expected salary range.
-
+- Salary Expectations
+  - Provide your expected salary range.
    - **salary_range_usd**: The salary range you are expecting, expressed in USD.

-##### Example
+  - Example:
  ```yaml
  salary_expectations:
    salary_range_usd: "80000 - 100000"
  ```

-#### Self-Identification
-
-##### Description
-Provide information related to personal identity, including gender and pronouns.
-
+- 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.

-##### Example
+  - Example:
  ```yaml
  self_identification:
    gender: "Female"
@ -398,11 +366,9 @@ self_identification:
    ethnicity: "Asian"
  ```

-#### Legal Authorization
-
-##### Description
-Indicate your legal ability to work in various locations.
+- Legal Authorization

+  - 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).
@ -412,7 +378,7 @@ Indicate your legal ability to work in various locations.
    - **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
+  - Example:
  ```yaml
  legal_authorization:
    eu_work_authorization: "Yes"
@ -425,11 +391,9 @@ legal_authorization:
    requires_eu_sponsorship: "No"
  ```

-#### Work Preferences
-
-##### Description
-Specify your preferences for work arrangements and conditions.
+- Work Preferences

+  - 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).
@ -437,11 +401,9 @@ Specify your preferences for work arrangements and conditions.
    - **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
+  - Example:
  ```yaml
-work
-
-_preferences:
+  work_preferences:
    remote_work: "Yes"
    in_person_work: "No"
    open_to_relocation: "Yes"