From 584b851b4cb4e07bfee93474eced0c9fb2408182 Mon Sep 17 00:00:00 2001
From: adb <info@adb.sh>
Date: Sat, 30 Jan 2021 21:07:18 +0000
Subject: [PATCH] add build and run instructions

---
 README.md | 31 ++++++++++++++++++++++++++++++-
 1 file changed, 30 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9d94816..3d8614e 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,32 @@
 # RandomRedditMemesAPI
 
-an API that returns random Reddit Submissions written in Java
\ No newline at end of file
+an API that returns random Reddit Submissions written in Java
+
+## build and run
+
+### build project
+first make sure you're using Gradle 6.8 and openjdk-jdk8
+
+to build the project just run:
+```
+gradle build
+```
+
+### run
+to execute the .jar archive you built before run:
+```
+java -jar ./build/libs/RandomRedditMemesAPI.jar
+```
+
+### run inside docker
+to execute the .jar file inside docker use docker-compose:
+```
+docker-compose -p RandomRedditMemesAPI up -docker
+```
+
+### build docker image
+if you want to build a full docker image run:
+```
+docker build .
+```
+alternatively you can use `./docker/docker-compose.yml`