Seil0/Project-HomeFlix
Seil0/Project-HomeFlix
1
0
Fork 0
Code Issues 7 Pull Requests Releases 4 Wiki Activity

Updated Documentation (markdown)

Jannik 2018-03-11 19:48:26 +01:00
parent e2f3bd6459
commit 616e73f53c
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Documentation.md

@ -8,8 +8,15 @@ Clone Project-HomeFlix
go to the root folder of Project-HomeFlix and execute the following command go to the root folder of Project-HomeFlix and execute the following command
`mvn package` `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 ## Used libraries and apis
* JFoenix: https://github.com/jfoenixadmin/JFoenix * 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/ * Apache Log4j 2: https://logging.apache.org/log4j/2.x/
* OMDb API: https://www.omdbapi.com/ * OMDb API: https://www.omdbapi.com/
## Streaming support
## Series support ## Series support
The series support is currently wip, it is divided in two parts. The series support is currently wip, it is divided in two parts.
1. Series support for local files 1. Series support for local files