summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormsglm <msglm@techchud.xyz>2023-01-17 06:41:10 -0600
committermsglm <msglm@techchud.xyz>2023-01-17 06:41:10 -0600
commitd20773a14ea7f60dd9c1177d04e094bfbcb4b8dd (patch)
tree10373a7df7fcbb669b05d982df846e1db445bcf4
parent5e5ef059d67a4c1ddb039844caeca8c25e5451f7 (diff)
downloadindeedwatcher-d20773a14ea7f60dd9c1177d04e094bfbcb4b8dd.tar.gz
indeedwatcher-d20773a14ea7f60dd9c1177d04e094bfbcb4b8dd.tar.bz2
indeedwatcher-d20773a14ea7f60dd9c1177d04e094bfbcb4b8dd.zip
superior documentation
-rw-r--r--README.md19
-rw-r--r--config/config.toml7
2 files changed, 12 insertions, 14 deletions
diff --git a/README.md b/README.md
index 7dbbbb7..918e5fc 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,11 @@
+# Indeed-watcher
+This is a nim program for getting jobs from indeed delivered to you in an easy to parse format.
+# Config
-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
+All documentation of the config file can be found in the example config provided, located at config/config.toml. This file should be asjusted to your needs and moved to your config directory in a folder called `indeedwatcher` (i.e: ~/.config/indeedwatcher).
-https://URL.example
-Example Job Title
-
-Pay - Company - Part-time/contract/salary
-
-Description:
-
-Requirements:
+# Building
+This program is wrote in nim. Using nim's package manager and build system, **nimble**, you can build the software just by typing in `nimble build` while in the base directory of the git repo. This will output a compiled binary in `bin/`.
diff --git a/config/config.toml b/config/config.toml
index d65f652..5ec9bcf 100644
--- a/config/config.toml
+++ b/config/config.toml
@@ -1,6 +1,10 @@
-outdir = "/home/joybuke/Documents/Jobs/Potential/"
+#Output directory of the parsed jobs
+outdir = "/home/msglm/Documents/Jobs/Potential/"
+#port number that chromedriver will use
port = 9515
+#location of your chrome driver
chromedriver = "/usr/bin/chromedriver"
+#RSS feeds of indeed jobs
feeds = [
"https://rss.indeed.com/rss?q=Information%20Technology&l=Arkansas&jt=contract&explvl=entry_level",
"https://rss.indeed.com/rss?q=Information%20Technology&l=Arkansas&jt=temporary&explvl=entry_level",
@@ -187,4 +191,5 @@ feeds = [
]
[blacklist]
+#Terms that, if they appear in the title of a job, they'll be rejected instantly.
title= ["Senior", "Sr.", "Solid Waste", "Manager"]