Merge pull request #97 from hossain-khan/readme

[ADDED] Troubleshooting guide with nullable values
hossain-khan · Aug 29, 2024 · 93df9c4 · 93df9c4
2 parents 9ebf562 + af46f82
commit 93df9c4
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/.idea/kotlinc.xml b/.idea/kotlinc.xml
diff --git a/README.md b/README.md
@@ -29,6 +29,14 @@ Sample app for Google Location History Parser project.
 🟢 Got timeline edits: 195,444 items edited.
 ```
 
+## Troubleshooting
+Due to domain model class's nullability rule, you may see `Required value 'metadata' missing at $xyz` error.
+
+![image](https://github.com/user-attachments/assets/5227e892-ccee-4049-8d75-029cff0cd822)
+
+This error is due to the field being missing in the JSON data. 
+To fix this, you can update the model class and build the project again. Feel free to open pull-request with fixes.
+
 ## API Documentation
 
 📖 https://hossain-khan.github.io/kgeo-timeline/