diff --git a/blueprints/README.md b/blueprints/README.md index 2053ef2a..4a81f799 100644 --- a/blueprints/README.md +++ b/blueprints/README.md @@ -1,14 +1,27 @@ # Blueprints -This folder contains reusable templates ("blueprints") to help you quickly get started with projects using [App Platform](https://github.com/vRallev/app-platform). +This folder contains reusable templates ("blueprints") to help you quickly get started with projects +using [App Platform](https://github.com/vRallev/app-platform). Choose the starter for a minimal new +project or the list-detail blueprint for a more advanced, adaptive application. -## 📁 `starter/` +## 📁 [`starter/`](starter/) -The `starter/` blueprint provides everything you need to bootstrap a new project with App Platform. It includes: +The `starter/` blueprint provides everything you need to bootstrap a new project with App Platform. +It includes: - Pre-configured `build.gradle.kts` files for Kotlin Multiplatform - Android + iOS + Desktop + WASM targets with Compose UI enabled -- App Platform integrations like Molecule presenters and Kotlin Inject +- App Platform integrations like Molecule presenters and Metro dependency injection - A working module structure with navigation and templates -> 💡 More blueprints may be added in the future to support different project styles or configurations. +## 📁 [`list-detail/`](list-detail/) + +The `list-detail/` blueprint demonstrates a complete, adaptive App Platform application. +It includes: + +- Android, iOS, Desktop, and WASM targets with shared Compose UI +- Adaptive phone and tablet layouts with single-pane navigation and two-pane presentation +- Molecule presenters, Metro dependency injection, and model-driven renderers +- Navigation 3 and shared-element transitions between the list and detail screens +- Reusable feature modules, fakes, and UI-test robots +- Pre-configured Groovy Gradle build files and standalone CI workflows