diff --git a/README.md b/README.md index e9137d5..88f5c7d 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,8 @@ vinted-rs = { version = "0.10.0", ### Advanced filters -> This feature requires [setting up a Postgres Database](#database-set-up) +> [!NOTE] +> This feature requires [setting up a Postgres Database](#database-set-up) Uses the data pulled by the [scrapping module](./scrapping/vinted-db-feeder/), which is stored in the diesel [migrations](./migrations/) folder. @@ -47,7 +48,8 @@ Uses the data pulled by the [scrapping module](./scrapping/vinted-db-feeder/), w #### Database set-up Advanced filtering features must require this setup before running. -1. ⚠️ `diesel-cli` installation may fail if you do not have `libpq` library installed. To install `libpq`, just install PostgreSQL package on your machine. +> [!IMPORTANT] +`diesel-cli` installation may fail if you do not have `libpq` library installed. To install `libpq`, just install PostgreSQL package on your machine. - In `Arch` based is only necessary to install this package. @@ -100,6 +102,7 @@ Advanced filtering features must require this setup before running. #### Testing set-up +> [!NOTE] > This step requires completing the [DB setup](#database-set-up) ```bash @@ -107,11 +110,10 @@ cargo test ``` ### Redis - This feature allows recovered results to be cached using a Redis instance. A development instance can be created using: ```bash make cache -``` \ No newline at end of file +```