added readme for project setup

sgcodigo · Sep 20, 2019 · 2871c66 · 2871c66
1 parent 8574ed5
commit 2871c66
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 8 deletions.
diff --git a/.idea/codeStyles/Project.xml b/.idea/codeStyles/Project.xml
diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml
diff --git a/README.md b/README.md
@@ -0,0 +1,11 @@
+
+# Glory
+
+## Setup
+
+Before opening the project, you need to create **confidential.properties** file in the project root directory and add your **TMDB** api key like below:
+```
+TMDB_API_KEY = "your_api_key"
+```
+
+If you don't have an api key yet, go ahead and register an api key [here](https://www.themoviedb.org).