Skip to content

Commit ce892df

Browse files
Update README with app icon and screenshots
1 parent f6bef95 commit ce892df

File tree

6 files changed

+35
-11
lines changed

6 files changed

+35
-11
lines changed

README.md

Lines changed: 35 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
1+
<p align="center">
2+
<img src="app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp" alt="QuickStack app icon" width="96" height="96">
3+
</p>
4+
15
# QuickStack
26

37
QuickStack is an Android fast-capture app built around the Quick Settings Tile.
48

5-
The goal is simple: capture something useful in a few seconds, then get out.
9+
The goal is simple: pull down Quick Settings, tap the tile, capture something useful in a few seconds, then get out.
10+
11+
## Screenshots
12+
13+
<p align="center" width="100%">
14+
<img src="docs/screenshots/quick-tile.png" alt="Quick Settings Tile" width="25%"><img src="docs/screenshots/quick-capture.png" alt="Quick Capture" width="25%"><img src="docs/screenshots/home.png" alt="Home" width="25%"><img src="docs/screenshots/settings.png" alt="Settings" width="25%"><img src="docs/screenshots/reminder-notifications.png" alt="Reminder notifications" width="25%">
15+
</p>
616

717
QuickStack currently supports:
818

@@ -14,6 +24,12 @@ QuickStack currently supports:
1424
- a local inbox/history
1525
- lightweight settings for language and time-action presets
1626

27+
## Why QuickStack
28+
29+
- `Quick Settings Tile` first: capture starts from the fastest Android surface available
30+
- minimal actions: note, clipboard, reminder, and timer presets without form-heavy flows
31+
- local-first: everything stays on device with native Android persistence and notifications
32+
1733
## Status
1834

1935
This repository contains a working MVP foundation.
@@ -54,16 +70,25 @@ QuickStack is intentionally narrow.
5470

5571
## Screens
5672

57-
- `Home`: inbox/history of saved items
58-
- `Quick Capture`: note, clipboard, reminder, and timer entry point
59-
- `Settings`: language, time actions, app version
73+
### Quick Tile
74+
75+
The tile is the primary entry point. One tap opens Quick Capture directly from Quick Settings.
76+
77+
### Quick Capture
78+
79+
Full-screen fast capture for notes, clipboard actions, reminders, and timer presets.
80+
81+
### Home
82+
83+
Local inbox/history for saved, pinned, scheduled, and completed items.
84+
85+
### Settings
86+
87+
Language selection, time-action presets, and app version in a lightweight settings area.
6088

61-
Suggested screenshot paths:
89+
### Notifications
6290

63-
- `docs/screenshots/home.png`
64-
- `docs/screenshots/quick-capture.png`
65-
- `docs/screenshots/settings.png`
66-
- `docs/screenshots/reminder-notification.png`
91+
Pinned items stay visible, while reminder and timer triggers arrive as actionable notifications.
6792

6893
## Tech Stack
6994

@@ -144,7 +169,7 @@ Main package responsibilities:
144169
- `data`: Room persistence, entity mapping, clipboard access, and settings persistence
145170
- `domain`: app-level models used across features without UI or storage details
146171
- `navigation`: top-level Compose navigation graph and route definitions
147-
- `feature/capture`: transparent capture surface, quick actions, and note/clipboard/reminder entry flows
172+
- `feature/capture`: full-screen quick capture surface, quick actions, and note/clipboard/reminder entry flows
148173
- `feature/home`: inbox/history presentation, deletion, completion, and item actions
149174
- `feature/notifications`: persistent and actionable notifications plus broadcast action handling
150175
- `feature/reminders`: reminder/timer scheduling logic built on `AlarmManager`
@@ -235,7 +260,6 @@ This repository is published under `Apache-2.0`.
235260

236261
## Good First Issues
237262

238-
- add screenshots to `docs/screenshots`
239263
- localize the new user-facing message strings in all supported languages
240264
- add more tests for Room-backed item state transitions
241265
- add reboot rescheduling for pending reminder/timer items

docs/screenshots/home.png

89.1 KB
Loading

docs/screenshots/quick-capture.png

100 KB
Loading

docs/screenshots/quick-tile.png

74.5 KB
Loading
76.2 KB
Loading

docs/screenshots/settings.png

66.3 KB
Loading

0 commit comments

Comments
 (0)