Skip to content

docs: README describes the current state - #18

Merged
mikahatdichlieb merged 2 commits into
mainfrom
docs/readme-status
Oct 26, 2026
Merged

mikahatdichlieb merged 2 commits into
mainfrom
docs/readme-status

Conversation

@mikahatdichlieb

Copy link
Copy Markdown
Contributor

The README still said "no features yet". It now describes:

  • Status: first complete flow, not yet tested on a real device, no release build.
  • What the app does: pairing, usage access, collection and sync. This includes that there is no Wi-Fi detection (so Tailscale works) and that offline entries are sent later.
  • What is sent: package name, start time and duration per session, and explicitly what is not sent.
  • Requirements: Android 8.0+, and a server certificate the device trusts.
  • Licensing: the bundled fonts and icon.

CLAUDE.md gains a workflow rule: every PR that changes what the app does updates the README in the same PR.

Docs only, no issue (trivial).

@mikahatdichlieb
mikahatdichlieb merged commit 3ce1d23 into main Oct 26, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant