From 616e73f53cd02058a4498cf8dd0fe02bf6e3c75a Mon Sep 17 00:00:00 2001 From: Jannik Date: Sun, 11 Mar 2018 19:48:26 +0100 Subject: [PATCH] Updated Documentation (markdown) --- Documentation.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/Documentation.md b/Documentation.md index c549f70..55b5c82 100644 --- a/Documentation.md +++ b/Documentation.md @@ -8,8 +8,15 @@ Clone Project-HomeFlix go to the root folder of Project-HomeFlix and execute the following command `mvn package` -The final package can be found in /target. +The final package can be found in /target. +If you want to use the omdb API you'll need to add a apikey.json in /resources +``` json +{ + "omdbAPIKey":"YOURKEY", + "tmdbAPIKey":"YOURKEY" +} +``` ## Used libraries and apis * JFoenix: https://github.com/jfoenixadmin/JFoenix @@ -19,8 +26,6 @@ The final package can be found in /target. * Apache Log4j 2: https://logging.apache.org/log4j/2.x/ * OMDb API: https://www.omdbapi.com/ -## Streaming support - ## Series support The series support is currently wip, it is divided in two parts. 1. Series support for local files