Skip to content

README: add architecture overview section#279

Merged
sjp4 merged 1 commit into
masterfrom
readme-architecture
Jul 2, 2026
Merged

README: add architecture overview section#279
sjp4 merged 1 commit into
masterfrom
readme-architecture

Conversation

@ericmigi

@ericmigi ericmigi commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Adds a short Architecture section near the top of the README, written for a mobile developer with no prior Pebble experience.

It covers:

  • What a Pebble is and what a companion app actually does (persistent Bluetooth connection, notification relay, data sync, network proxying)
  • The Kotlin Multiplatform + Compose Multiplatform setup (shared UI, expect/actual platform code, thin Swift shell on iOS)
  • Core libpebble3 concepts: Pebble Protocol, connection-scoped services & endpoint managers, BlobDB sync, PebbleKit JS
  • A module map table and a one-line stack summary (Koin, Ktor, Room, Kermit)

Docs-only change.

🤖 Generated with Claude Code

Explains the companion-app model, the KMP/Compose Multiplatform setup,
core libpebble3 concepts (Pebble Protocol, services, BlobDB, PebbleKit JS),
and a module map — aimed at mobile developers new to Pebble.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@ericmigi ericmigi requested a review from sjp4 July 2, 2026 06:22
@ericmigi

ericmigi commented Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

@sjp4 had a request for a little more info in readme. I already made a change about contributions

@sjp4

sjp4 commented Jul 2, 2026

Copy link
Copy Markdown
Member

I already made a change about contributions

Where is that?

@sjp4 sjp4 merged commit 3501639 into master Jul 2, 2026
5 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.

2 participants