Merge pull request #6 from isoguzay/task/update-readme

task/update-readme

Author: isoguzay

README.md

@@ -1,4 +1,99 @@
-# Adyen Android Assignment
+# Adyen Android Assignment - Ismail Oguzhan Ay
+
+![Latest Version](https://img.shields.io/badge/latestVersion-1.0-yellow) ![Kotlin](https://img.shields.io/badge/language-kotlin-blue) ![Minimum SDK Version](https://img.shields.io/badge/minSDK-21-orange) ![Android Gradle Version](https://img.shields.io/badge/androidGradleVersion-7.1.1-green) ![Gradle Version](https://img.shields.io/badge/gradleVersion-7.0.4-informational)
+
+An android assignment project with Jetpack Compose, Coroutines, ViewModel, LiveData, Retrofit, Hilt and based on MVVM by using FourSquare Place API and Google Maps Compose.
+
+## ℹ Introduction
+
+It is about a demonstration application with FourSquare Place API. You get places(venues) information from FourSquare Place API service, then shows them on Google Maps. When you click on a place(marker on map), get details about the place. It starts with Adyen location, if you want see your current location places, you can click my location button and get them.
+
+## What You Will Need
+
+**Hardware Requirements**
+- A computer that can run Android Studio.
+- An Android phone for debugging.
+
+**Software Requirements**
+- Android SDK package
+- Android Studio 4.X
+
+## 🛠 Features
+
+- Get location permissions
+- Get user current location
+- Show nearby places on Google Map
+- Show places information on Google Map
+
+## 📱 Screenshots
+
+<p align="center">
+  <img src="docs/1.png" width="32%"/>
+  <img src="docs/2.png" width="32%"/>
+  <img src="docs/3.png" width="32%"/>
+</p>
+
+<p align="center">
+  <img src="docs/4.png" width="32%"/>
+  <img src="docs/5.png" width="32%"/>
+  <img src="docs/6.png" width="32%"/>
+</p>
+
+<p align="center">
+  <img src="docs/7.png" width="32%"/>
+  <img src="docs/8.png" width="32%"/>
+  <img src="docs/9.png" width="32%"/>
+</p>
+
+## 📲 Download
+
+Go to the [Releases](https://github.com/isoguzay/FoursquareApiCompose/releases) to download the latest APK.
+
+## 🏗 Tech Stack
+
+### Architecture
+
+- 100% Kotlin based, including Gradle files
+- MVVM Clean & Single-Based Architecture
+- Repository Pattern
+
+### Libraries
+
+- Minimum SDK level 21 + based on [Kotlin](https://kotlinlang.org/)
+
+- [Coroutines](https://github.com/Kotlin/kotlinx.coroutines) & [Flow](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/) - Perform asynchronous operations
+
+- [Hilt](https://dagger.dev/hilt/) - for dependency injection
+
+- Jetpack Libraries
+    - [Compose](https://developer.android.com/jetpack/compose/documentation) - Build modern declarative Android UI
+    - [Lifecycle](https://developer.android.com/jetpack/compose/lifecycle) - Observe lifecycle state changes
+    - [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel) - Store UI related data
+
+- [Retrofit Client](https://square.github.io/retrofit/) - Execute network service calls
+- [Splash API](https://developer.android.com/guide/topics/ui/splash-screen) - Customize your Splash without effort
+- [Timber](https://github.com/JakeWharton/timber) - Log your messages
+
+### Services
+
+- [FourSquare API Service](https://developer.foursquare.com/docs/places-api-getting-started) - FourSquare API 🗺📍
+- [Google Maps Compose](https://developers.google.com/maps/documentation/android-sdk/maps-compose) - Google Maps with Jetpack Compose 🌍
+
+## 📍 How to get the Foursquare API key?
+
+Register [here](https://developer.foursquare.com/docs/manage-api-keys) and get your own Foursquare API key for your builds. You should add your API key to local.gradle.
+
+## 🌍 How to get the Google MAPS API key?
+
+Register [here](https://developers.google.com/maps/documentation/android-sdk/maps-compose) and get your own Google Maps API key for your builds. You should add your API key to as a meta-data under the AndroidManifest.xml file.
+
+
+
+# 💳 Cash Register
+
+
+
+# Adyen Android Assignment - Requirements
 
 This repository contains the coding challenge for candidates applying for a Senior Android role at Adyen.
 It consists of two unrelated parts:
@@ -25,5 +120,4 @@ You are free to add any feature or code you want, but we also value quality over
 
 ### Setup
 Add your Foursquare client ID and secret to `local.gradle`. See `local.gradle.example` for details.
-Tip: You can verify your credentials with `src/test/java/com/adyen/android/assignment/PlacesUnitTest.kt`# FoursquareApiCompose
-# FoursquareApiCompose
+Tip: You can verify your credentials with `src/test/java/com/adyen/android/assignment/PlacesUnitTest.kt`# FoursquareApiCompose