diff options
| author | msglm <msglm@techchud.xyz> | 2023-01-17 06:41:10 -0600 |
|---|---|---|
| committer | msglm <msglm@techchud.xyz> | 2023-01-17 06:41:10 -0600 |
| commit | d20773a14ea7f60dd9c1177d04e094bfbcb4b8dd (patch) | |
| tree | 10373a7df7fcbb669b05d982df846e1db445bcf4 /README.md | |
| parent | 5e5ef059d67a4c1ddb039844caeca8c25e5451f7 (diff) | |
| download | indeedwatcher-d20773a14ea7f60dd9c1177d04e094bfbcb4b8dd.tar.gz indeedwatcher-d20773a14ea7f60dd9c1177d04e094bfbcb4b8dd.tar.bz2 indeedwatcher-d20773a14ea7f60dd9c1177d04e094bfbcb4b8dd.zip | |
superior documentation
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 19 |
1 files changed, 6 insertions, 13 deletions
@@ -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/`. |