[#26] Updated README again

master^2
Jef Roosens 2021-04-16 09:22:30 +02:00
parent 45c4a4e257
commit c2fa764e80
Signed by: Jef Roosens
GPG Key ID: 955C0660072F691F
1 changed files with 4 additions and 8 deletions

View File

@ -5,14 +5,10 @@ experiment to learn Rust, but has grown into a full-on passion project.
## Project Structure ## Project Structure
The bulk of the project consists of the main `fej` library. The `src` folder The `src` folder contains subfolders for the various binaries and the main
contains the `lib.rs` file for this library, and all other binaries import from library, called `fej`. The biggest binary is called `server`, which is the
this main library. binary that actually runs the Rocket.rs web server. All the others are utility
programs, mostly consisting of scrapers for various services.
All binaries can be found in [`/src/bin`](src/bin), with the biggest one being
`server`. This is what actually runs as the Rocket.rs server. The other
binaries (with more possibly coming) are utility tools that will most likely be
run as cron jobs inside the containers, e.g. scrapers.
Version 1.1 also introduces the use of a database, namely Version 1.1 also introduces the use of a database, namely
[PostgreSQL 13](https://www.postgresql.org/). [PostgreSQL 13](https://www.postgresql.org/).