docs: add screenshot

mikucat0309 · Jan 6, 2024 · e2d09c5 · e2d09c5
1 parent b592453
commit e2d09c5
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -1,23 +1,47 @@
-# OPass Compose
-
-Status: **Work In Progress**
-
-## Development
-
-### Build Debug APK
-
-```sh
-./gradlew :app:assembleDebug
-```
-
-### Format
-
-```sh
-./gradlew :app:ktfmtFormat
-```
-
-### Lint
-
-```sh
-./gradlew :app:detekt
-```
+# OPass Compose
+
+Status: **Work In Progress**
+
+## Feature
+
+- [x] Home
+- [x] Switch events
+- [ ] Sessions
+  - [x] Browse
+  - [ ] Details
+- [ ] Ticket
+  - [x] Enter manually
+  - [ ] Scan a QR Code
+  - [ ] Scan a image
+  - [ ] Show my ticket
+- [ ] WebView
+- [ ] Settings
+  - [ ] Save tokens
+  - [ ] Local cache
+- [ ] Material Design 3 theme
+
+## Screenshot
+
+![home](images/home.png)
+![switch-event](images/switch-event.png)
+![schedule](images/schedule.png)
+
+## Development
+
+### Format
+
+```sh
+./gradlew :app:ktfmtFormat
+```
+
+### Lint
+
+```sh
+./gradlew :app:detekt
+```
+
+### Build Debug APK
+
+```sh
+./gradlew :app:assembleDebug
+```
diff --git a/images/home.png b/images/home.png
diff --git a/images/schedule.png b/images/schedule.png
diff --git a/images/switch-event.png b/images/switch-event.png