From 0d150d519f4af8b7e89c30fe418ae72e8258e540 Mon Sep 17 00:00:00 2001
From: Cullen Watson <cullen@bunsly.com>
Date: Mon, 11 Mar 2024 14:52:20 -0500
Subject: [PATCH] docs: readme

---
 README.md | 15 +++++++--------
 1 file changed, 7 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index cffb037..eb5e449 100644
--- a/README.md
+++ b/README.md
@@ -60,22 +60,21 @@ zip_recruiter Software Developer                 TEKsystems        Phoenix
 ### Parameters for `scrape_jobs()`
 
 ```plaintext
-Required
-├── site_type (List[enum]): linkedin, zip_recruiter, indeed, glassdoor
-└── search_term (str)
 Optional
+├── site_type (list): linkedin, zip_recruiter, indeed, glassdoor (default is all 4)
+├── search_term (str)
 ├── location (str)
 ├── distance (int): in miles, default 50
-├── job_type (enum): fulltime, parttime, internship, contract
+├── job_type (str): fulltime, parttime, internship, contract
 ├── proxy (str): in format 'http://user:pass@host:port'
 ├── is_remote (bool)
-├── linkedin_fetch_description (bool): fetches full description for LinkedIn (slower)
 ├── results_wanted (int): number of job results to retrieve for each site specified in 'site_type'
 ├── easy_apply (bool): filters for jobs that are hosted on the job board site (not supported on Indeed)
+├── linkedin_fetch_description (bool): fetches full description for LinkedIn (slower)
 ├── linkedin_company_ids (list[int): searches for linkedin jobs with specific company ids
-├── description_format (enum): markdown, html (format type of the job descriptions)
-├── country_indeed (enum): filters the country on Indeed (see below for correct spelling)
-├── offset (num): starts the search from an offset (e.g. 25 will start the search from the 25th result)
+├── description_format (str): markdown, html (format type of the job descriptions)
+├── country_indeed (str): filters the country on Indeed (see below for correct spelling)
+├── offset (int): starts the search from an offset (e.g. 25 will start the search from the 25th result)
 ├── hours_old (int): filters jobs by the number of hours since the job was posted (ZipRecruiter and Glassdoor round up to next day. If you use this on Indeed, it will not filter by job_type or is_remote)
 ├── verbose (int) {0, 1, 2}: Controls the verbosity of the runtime printouts (0 prints only errors, 1 is errors+warnings, 2 is all logs. Default is 2.)
 ```