design and data retreieval done

1 files changed, 18 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7dbbbb7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+
+
+
+reads configutation from a toml file
+intakes a link to an indeed page
+parses page, looks for info like offered pay, job description, vax status, etc to make a score
+if the job doesn't meet the configured minimum score, the job is discarded
+if it's not, it should return the article in the following format so the user can put it in whatever folder desired
+
+https://URL.example
+Example Job Title
+
+Pay - Company - Part-time/contract/salary
+
+Description:
+
+Requirements:
+