Create README.md

jja08111 · Jul 21, 2024 · cfd8486 · cfd8486
1 parent 25f3ec6
commit cfd8486
Show file tree

Hide file tree

Showing 7 changed files with 44 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,46 @@
-# Gemini Demo App
+# Gemini Android
 
-**Goals**
+| Chat                   | Take picture                           | Pick images                          |
+|------------------------|----------------------------------------|--------------------------------------|
+| ![chat](docs/chat.gif) | ![take_picture](docs/take_picture.gif) | ![pick_images](docs/pick_images.gif) |
 
-- [ ] Improving reusability and scalability by using modularization
-- [ ] Supporting the wearable OS
-- [ ] Supporting talk to chat
-- [ ] Adapting to diverse display sizes, including tablets and foldable devices.
+| Regenerate                         | Select response                              | 
+|------------------------------------|----------------------------------------------|
+| ![regenerate](docs/regenerate.gif) | ![select-response](docs/select_response.gif) |
+
+## How to run?
+
+1. [Create a Gemini API key](https://ai.google.dev/gemini-api/docs/api-key).
+2. Create a `secrets.properties` file in a root directory.
+3. Setup the API key in the `secrets.properties`.
+   ```properties
+   GEMINI_API_KEY=YOUR_API_KEY
+   ```
+4. Build and run the App.
+
+## Features
+
+- Chat with **Gemini AI** using text messages and images.
+- Save chat history in the local database using Android Room.
+- (Upcoming) Support for Wear OS integration.
+
+## Tech stacks
+
+- 100% Jetpack Compose based + Coroutines + Flow for asynchronous.
+- Gemini SDK
+- Jetpack
+    - Compose
+    - ViewModel
+    - Hilt
+    - Room
+- Glide
+- Robolectric
+
+## Architecture
+
+Gemini Android follows the
+[Google's official architecture guidance](https://developer.android.com/topic/architecture)
+
+## ERD
+
+![erd](docs/erd.png)
diff --git a/docs/chat.gif b/docs/chat.gif
diff --git a/docs/erd.png b/docs/erd.png
diff --git a/docs/pick_images.gif b/docs/pick_images.gif
diff --git a/docs/regenerate.gif b/docs/regenerate.gif
diff --git a/docs/select_response.gif b/docs/select_response.gif
diff --git a/docs/take_picture.gif b/docs/take_picture.gif