Create README.md

README.md

@@ -0,0 +1,27 @@
+# Stock Market Check 📈
+
+[![Android-CI Actions Status](https://img.shields.io/badge/Android--CI-passing-brightgreen?logo=github)](https://github.com/LeonelZalegas/StockMarketCheck/actions)
+[![ktlint](https://img.shields.io/badge/code%20style-%E2%9D%A4-FF4081.svg)](https://ktlint.github.io/)
+![Tests](https://img.shields.io/badge/Tests-Passing-brightgreen.svg)
+
+**Stock Market Check** is a native Android application developed in Kotlin, designed to provide users with easy access to stock market information. This app allows users to browse and search for publicly traded companies, view basic company information, and track real-time stock performance. With its user-friendly interface and up-to-date data, Stock Market Explorer is an ideal tool for anyone interested in staying informed about the stock market.
+
+## 🛠 Built With
+
+<img src="StockMarketCheckGIF.gif" align="right" width="290"/>
+
+|Architecture                           | [Clean MVVM Architecture](https://developer.android.com/topic/architecture).                                                                                 |
+|-----------------------------------|--------------------------------------------------------------------------------------------|
+| <img height="20" src="https://3.bp.blogspot.com/-VVp3WvJvl84/X0Vu6EjYqDI/AAAAAAAAPjU/ZOMKiUlgfg8ok8DY8Hc-ocOvGdB0z86AgCLcBGAsYHQ/s1600/jetpack%2Bcompose%2Bicon_RGB.png">    UI Framework  | [Jetpack Compose](https://developer.android.com/jetpack/compose) |
+| 💉 Dependency Injection           | [Dagger-Hilt](https://dagger.dev/hilt/)                                                    |
+| 🌐 Networking                     | [Retrofit](https://square.github.io/retrofit/) + [Gson](https://github.com/google/gson)     |
+| 🗄️ Local Database                 | [Room Database](https://developer.android.com/jetpack/androidx/releases/room)  (Single source of truth)            |
+| 🚦 Navigation                     | [Type-Safe Navigation](https://developer.android.com/guide/navigation/design/type-safety)  |
+| 🔄 State Management               | [Flows](https://kotlinlang.org/docs/flow.html) + [StateFlows](https://developer.android.com/kotlin/flow/stateflow-and-sharedflow) |
+| 🛠️ Dependency Management          | [Gradle Kotlin DSL](https://docs.gradle.org/current/userguide/kotlin_dsl.html)             |
+| 📊 Graph Creation                 | [YCharts](https://github.com/YCharts/ycharts)                                              |
+| 🧪 Testing                        | [JUnit](https://junit.org/junit5/) + [MockK](https://mockk.io/)                            |
+| 📦 Dependency Injection Compiler  | [KSP](https://github.com/google/ksp)                                                       |
+| 📋 CSV Parsing                    | [OpenCSV](http://opencsv.sourceforge.net/)                                                 |
+| 📱 UI Testing                     | [Compose UI Testing](https://developer.android.com/jetpack/compose/testing)                |
+| 🔍 Linting                        | [Ktlint](https://ktlint.github.io/)                                                        |