summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 918e5fc59780cc88abb90292b3a958d447857617 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
# Indeed-watcher

This is a nim program for getting jobs from indeed delivered to you in an easy to parse format.

# Config

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).

# 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/`.