Docker/-compose

README.md

@@ -1,6 +1,6 @@
 # EasyDrop
 
-![Version](https://img.shields.io/badge/version-0.3.0_SNAPSHOT-orange)
+![Version](https://img.shields.io/badge/version-0.3.0–SNAPSHOT-orange)
 ![Pipeline](https://gitlab.fbe-adswen.rwu.de/team1/sandbox2/badges/main/pipeline.svg)
 [![Coverage](https://sonar.fbe-adswen.rwu.de/api/project_badges/measure?project=de.rwu%3Aeasydrop&metric=coverage&token=sqb_2fe80aed361468170aaef32a0ff96d596456cdd1)](https://sonar.fbe-adswen.rwu.de/dashboard?id=de.rwu%3Aeasydrop)
 ![JAMANN](https://img.shields.io/badge/Auszahlung-Letzte%20Woche-brightgreen)
@@ -13,30 +13,37 @@ Get rich quick™ with fully automated dropshipping!
 
 ![Demo Image](Docs/DemoImage.png)
 
-## Installation ⚙
+## Installation/Usage ⚙
 
-As the application is still in development, development software will be required along its regular execution environment.
-
-- JDK 17
-- Maven
-- _[More/context](https://gitlab.fbe-adswen.rwu.de/team1/sandbox2/-/wikis/Projektdokumentation/Development#software)_
-
-## Usage 🛠
+- Install Docker + Compose
+- Clone this repository
 
 Set up the required configuration files, use the corresponding demo files for orientation.
 
 - `config/config.properties` for API authorization
 - `products-config.json` to define product catalogues to use for dropshipping
 
-Run the following command to execute the program:
+Create the container
 
-```sh
-mvn compile exec:java -Dexec.mainClass="de.rwu.easydrop.Main"
+```bash
+docker-compose build
+```
+
+Then run it!
+
+```bash
+docker-compose up
+```
+
+To run it on a fixed schedule, install a cron job, e.g.
+
+```bash
+*/30 * * * * cd /home/user/easydrop && docker-compose up -d
 ```
 
 ## Roadmap 🏁
 
-_Future ideas!_
+- Access transaction log
 
 ## Contributing 👷‍♂️👷‍♀️