Skip to content

Commit 8acf8d0

Browse files
Merge pull request #847 from android/main-readme-compose
Updates main README
2 parents 8438cb9 + aa29522 commit 8acf8d0

File tree

1 file changed

+18
-20
lines changed

1 file changed

+18
-20
lines changed

README.md

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
1-
# Android Architecture Blueprints v2
1+
# Android Architecture Blueprints
22
<p align="center">
33
<img src="https://github.com/googlesamples/android-architecture/wiki/images/aab-logov2.png" alt="Illustration by Virginia Poltrack"/>
44
</p>
55

66
Android Architecture Blueprints is a project to showcase different architectural approaches to developing Android apps. In its different branches you'll find the same app (a TODO app) implemented with small differences.
77

88
In this branch you'll find:
9-
* Kotlin **[Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html)** for background operations.
10-
* A single-activity architecture, using the **[Navigation component](https://developer.android.com/guide/navigation/navigation-getting-started)** to manage fragment operations.
11-
* A presentation layer that contains a fragment (View) and a **ViewModel** per screen (or feature).
12-
* Reactive UIs using **LiveData** observables and **Data Binding**.
13-
* A **data layer** with a repository and two data sources (local using Room and remote) that are queried with one-shot operations (no listeners or data streams).
14-
* Two **product flavors**, `mock` and `prod`, [to ease development and testing](https://android-developers.googleblog.com/2015/12/leveraging-product-flavors-in-android.html) (except in the Dagger branch).
9+
* User Interface built with **[Jetpack Compose](https://developer.android.com/jetpack/compose)**
10+
* A single-activity architecture, using **[Navigation Compose](https://developer.android.com/jetpack/compose/navigation)**.
11+
* A presentation layer that contains a Compose screen (View) and a **ViewModel** per screen (or feature).
12+
* Reactive UIs using **[LiveData](https://developer.android.com/topic/libraries/architecture/livedata)** and **[coroutines](https://kotlinlang.org/docs/coroutines-overview.html)** for asynchronous operations.
13+
* A **data layer** with a repository and two data sources (local using Room and a fake remote).
14+
* Two **product flavors**, `mock` and `prod`, [to ease development and testing](https://android-developers.googleblog.com/2015/12/leveraging-product-flavors-in-android.html).
1515
* A collection of unit, integration and e2e **tests**, including "shared" tests that can be run on emulator/device or Robolectric.
16+
* A simple service locator for inversion of control.
1617

1718
## Variations
1819

@@ -21,13 +22,10 @@ This project hosts each sample app in separate repository branches. For more inf
2122
### Stable samples - Kotlin
2223
| Sample | Description |
2324
| ------------- | ------------- |
24-
| [master](https://github.com/googlesamples/android-architecture/tree/master) | The base for the rest of the branches. <br/>Uses Kotlin, Architecture Components, coroutines, Data Binding, etc. and uses Room as source of truth, with a reactive UI. |
25-
| [dagger-android](https://github.com/googlesamples/android-architecture/tree/dagger-android)<br/>[[compare](https://github.com/googlesamples/android-architecture/compare/dagger-android#files_bucket)] | A simple Dagger setup that uses `dagger-android` and removes the two flavors. |
26-
| [usecases](https://github.com/googlesamples/android-architecture/tree/usecases)<br/>[[compare](https://github.com/googlesamples/android-architecture/compare/usecases#files_bucket)] | Adds a new domain layer that uses UseCases for business logic. |
27-
28-
### Old samples - Kotlin and Java
29-
30-
Blueprints v1 had a collection of samples that are not maintained anymore, but can still be useful. See [all project branches](https://github.com/googlesamples/android-architecture/branches).
25+
| [main](https://github.com/googlesamples/android-architecture/tree/main) | This branch |
26+
| [hilt](https://github.com/googlesamples/android-architecture/tree/hilt) | A simple Hilt setup that removes the two flavors and service locator (not using Compose yet) |
27+
| [usecases](https://github.com/googlesamples/android-architecture/tree/usecases) | Adds a new domain layer that uses UseCases for business logic (not using Compose yet) |
28+
| [views](https://github.com/googlesamples/android-architecture/tree/views) | Uses Views instead of Jetpack Compose to render UI elements on the screen |
3129

3230
## Why a to-do app?
3331

@@ -37,9 +35,9 @@ The app in this project aims to be simple enough that you can understand it quic
3735

3836
## What is it not?
3937

40-
* A UI/Material Design sample. The interface of the app is deliberately kept simple to focus on architecture. Check out [Plaid](https://github.com/android/plaid) instead.
41-
* A complete Jetpack sample covering all libraries. Check out [Android Sunflower](https://github.com/googlesamples/android-sunflower) or the advanced [Github Browser Sample](https://github.com/googlesamples/android-architecture-components/tree/master/GithubBrowserSample) instead.
42-
* A real production app with network access, user authentication, etc. Check out the [Google I/O app](https://github.com/google/iosched), [Santa Tracker](https://github.com/google/santa-tracker-android) or [Tivi](https://github.com/chrisbanes/tivi) for that.
38+
* A UI/Material Design sample. The interface of the app is deliberately kept simple to focus on architecture. Check out the [Compose Samples](https://github.com/android/compose-samples) instead.
39+
* A complete Jetpack sample covering all libraries. Check out [Android Sunflower](https://github.com/googlesamples/android-sunflower) or the advanced [GitHub Browser Sample](https://github.com/googlesamples/android-architecture-components/tree/master/GithubBrowserSample) instead.
40+
* A real production app with network access, user authentication, etc. Check out the [Google I/O app](https://github.com/google/iosched) instead.
4341

4442
## Who is it for?
4543

@@ -53,7 +51,7 @@ To open one of the samples in Android Studio, begin by checking out one of the s
5351
Clone the repository:
5452

5553
```
56-
git clone [email protected]:googlesamples/android-architecture.git
54+
git clone [email protected]:android/architecture-samples.git
5755
```
5856
This step checks out the master branch. If you want to change to a different sample:
5957

@@ -63,13 +61,13 @@ git checkout usecases
6361

6462
**Note:** To review a different sample, replace `usecases` with the name of sample you want to check out.
6563

66-
Finally open the `android-architecture/` directory in Android Studio.
64+
Finally open the `architecture-samples/` directory in Android Studio.
6765

6866
### License
6967

7068

7169
```
72-
Copyright 2019 Google, Inc.
70+
Copyright 2022 Google, Inc.
7371
7472
Licensed to the Apache Software Foundation (ASF) under one or more contributor
7573
license agreements. See the NOTICE file distributed with this work for

0 commit comments

Comments
 (0)