Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,17 @@ Kotlin Multiplatform shared logic. SwiftUI on iOS. Jetpack Compose on Android.
Talks to an FTW box over an encrypted session; the box is the authority and
this app is a cached projection of it.

## Shared product direction

[FTW's vision](https://github.com/srcfl/ftw/blob/master/VISION.md) governs the native client.
Fredrik owns the direction and Sourceful develops it. External users submit
issues, not PRs; see [CONTRIBUTING.md](CONTRIBUTING.md).

The full product aims for clear live command/outcome feedback, simple charging
and useful notifications. Those goals do not remove the current native release
gates below or claim features are present on either phone. Reuse Core's
contracts and authority as native scope expands.

## Current v1

Pair + Now only. Shipped on `main` as of 2026-08-22. Persist vault, site and
Expand All @@ -23,7 +34,8 @@ The protocol, the QR, the relay and the identity model are specified in
**Lean, snappy, just works.** Same constraint as the web app.

- Nothing blocks the first frame. Paint from cache, catch up.
- No configuration. No server to choose, no transport to pick.
- Few required choices. Hide transport setup; expose useful household goals
and expert controls when their flows are implemented.
- Failures heal themselves. A dropped connection reconnects on its own.
There is no reconnect button.
- Errors say what happens now, not what broke inside.
Expand Down
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Contributing to the FTW native app

Sourceful develops this project. Fredrik owns FTW's product direction in
[the shared vision](https://github.com/srcfl/ftw/blob/master/VISION.md). External users submit
[issues](https://github.com/srcfl/ftw-app/issues) with bugs, needs and evidence.
We do not accept external pull requests, including documentation changes.
Acceptance of an issue does not invite an external implementation PR.

Describe the expected result, what happened, the version and relevant
hardware. You do not need to write code. Keep credentials, keys and private
site data out of public reports. Sourceful selects and implements changes.

Existing license rights and copyright attributions remain unchanged.
Sourceful implementation PRs should state the user need, coordinate overlap,
include relevant verification and follow the repository's development guide.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,18 @@ home is the record. This app is a cached projection of it. The cloud is blind.
Not a wrap of the [web app](https://github.com/srcfl/ftw-webapp). Same protocol,
same QR, same relay, same RP ID (`app.ftw.energy`).

## Product direction and contributions

Follow [FTW's shared vision](https://github.com/srcfl/ftw/blob/master/VISION.md) and
[roadmap](https://github.com/srcfl/ftw/blob/master/docs/roadmap.md). The target experience needs
few routine choices, honest live feedback and reliable daily charging.
The native status below is a dated record and its verification gates still
apply; the vision does not declare new native features shipped.

Sourceful develops this app. External users submit
[issues](https://github.com/srcfl/ftw-app/issues), not pull requests.
See [CONTRIBUTING.md](CONTRIBUTING.md).

## Shape

```
Expand Down