diff --git a/BasicRxJavaSample/README.md b/BasicRxJavaSample/README.md index 20841ce63..41afb6bc6 100644 --- a/BasicRxJavaSample/README.md +++ b/BasicRxJavaSample/README.md @@ -1,13 +1,12 @@ Room & RxJava Sample ===================== +Demos observable queries in Room with RxJava's Flowable objects. +## Introduction This is an API sample to showcase how to implement observable queries in [Room](https://developer.android.com/topic/libraries/architecture/room.html), with RxJava's [Flowable](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Flowable.html) objects. -Introduction -------------- - ### Functionality The sample app shows an editable user name, stored in the database. diff --git a/BasicRxJavaSampleKotlin/README.md b/BasicRxJavaSampleKotlin/README.md index e53627e80..a5ab1f8d1 100644 --- a/BasicRxJavaSampleKotlin/README.md +++ b/BasicRxJavaSampleKotlin/README.md @@ -1,12 +1,11 @@ Room & RxJava (Kotlin) Sample ============================ +Demos Room with RxJava's Flowable objects in Kotlin. +## Introduction This is an API sample to showcase how to use [Room](https://developer.android.com/topic/libraries/architecture/room.html), with RxJava's [Flowable](http://reactivex.io/RxJava/2.x/javadoc/io/reactivex/Flowable.html) objects in Kotlin. -Introduction -------------- - ### Functionality The sample app shows an editable user name, stored in the database. diff --git a/BasicSample/README.md b/BasicSample/README.md index 4e343baa9..9c91ae164 100644 --- a/BasicSample/README.md +++ b/BasicSample/README.md @@ -1,15 +1,14 @@ Android Architecture Components Basic Sample ============================================= +Demos multiple Architecture Components (Room, ViewModels, and LiveData) working together. +## Introduction This sample showcases the following Architecture Components: * [Room](https://developer.android.com/topic/libraries/architecture/room.html) * [ViewModels](https://developer.android.com/reference/android/arch/lifecycle/ViewModel.html) * [LiveData](https://developer.android.com/reference/android/arch/lifecycle/LiveData.html) -Introduction -------------- - ### Features This sample contains two screens: a list of products and a detail view, that shows product reviews. diff --git a/GithubBrowserSample/README.md b/GithubBrowserSample/README.md index 40815a66c..7e1bfba88 100644 --- a/GithubBrowserSample/README.md +++ b/GithubBrowserSample/README.md @@ -1,15 +1,14 @@ Github Browser Sample with Android Architecture Components =========================================================== +Demos Android Architecture Components with Dagger 2. +## Introduction This is a sample app that uses Android Architecture Components with Dagger 2. **NOTE** It is a relatively more complex and complete example so if you are not familiar with [Architecture Components][arch], you are highly recommended to check other examples in this repository first. -Introduction -------------- - ### Functionality The app is composed of 3 main screens. #### SearchFragment diff --git a/LiveDataSample/README.md b/LiveDataSample/README.md index f4c1c024f..449a77c7c 100644 --- a/LiveDataSample/README.md +++ b/LiveDataSample/README.md @@ -1,6 +1,8 @@ Kotlin Coroutines with Architecture Components (LiveData, ViewModel, Lifecycle) ============================================= +Demos multiple Architecture Components together (LiveData, ViewModels, and DataBinding). +## Introduction This sample showcases the following Architecture Components: * [LiveData](https://developer.android.com/reference/android/arch/lifecycle/LiveData.html) @@ -14,9 +16,6 @@ And the following artifacts: This project shows how to integrate them with Kotlin's coroutines using the `liveData` builder. -Introduction -------------- - LiveData is a data holder class that can be observed within a given lifecycle. Usually, you use LiveData to communicate a ViewModel with a View. In this project you'll find different patterns showcasing the `liveData` builder that lets you control a LiveData from a coroutine block. ## Patterns diff --git a/MADSkillsNavigationSample/README.md b/MADSkillsNavigationSample/README.md index e0e919e47..8a8acad29 100644 --- a/MADSkillsNavigationSample/README.md +++ b/MADSkillsNavigationSample/README.md @@ -1,6 +1,8 @@ MAD Skills Navigation Sample (Donut Tracker) ============================================== +Demos Navigation component highlighted in the MAD Skills video series. +## Introduction This sample shows the features of Navigation component highlighted by the Navigation episodes in the MAD Skills series of [videos](https://www.youtube.com/user/androiddevelopers) and [articles](https://medium.com/androiddevelopers). Specifically, episodes @@ -43,4 +45,4 @@ Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under -the License. \ No newline at end of file +the License. diff --git a/NavigationAdvancedSample/README.md b/NavigationAdvancedSample/README.md index 0648b252d..d52d9e5e7 100644 --- a/NavigationAdvancedSample/README.md +++ b/NavigationAdvancedSample/README.md @@ -1,8 +1,9 @@ Android Architecture Components Advanced Navigation Sample ============================================== +Demos bottom navigation view following the Principles of Navigation. -### Features - +Features +-------- This sample showcases the behavior of a bottom navigation view following the [Principles of Navigation](https://developer.android.com/topic/libraries/architecture/navigation#fixed). diff --git a/NavigationBasicSample/README.md b/NavigationBasicSample/README.md index 6e5962e62..29706036e 100644 --- a/NavigationBasicSample/README.md +++ b/NavigationBasicSample/README.md @@ -1,6 +1,8 @@ Android Architecture Components Navigation Basic Sample ============================================== +Demos Navigation component with focus on actions, transitions, back stack, arguments, and deep links. +## Introduction ### Features This sample showcases the following features of the Navigation component: diff --git a/PagingSample/README.md b/PagingSample/README.md index d975917d2..2303148ae 100644 --- a/PagingSample/README.md +++ b/PagingSample/README.md @@ -1,6 +1,8 @@ Android Architecture Components Paging Sample ============================================== +Demos Architecture Components (Paging, Room, ViewModels, and LiveData) working together. +## Introduction This sample showcases the following Architecture Components: * [Paging](https://developer.android.com/topic/libraries/architecture/paging.html) @@ -8,9 +10,6 @@ This sample showcases the following Architecture Components: * [ViewModels](https://developer.android.com/reference/android/arch/lifecycle/ViewModel.html) * [LiveData](https://developer.android.com/reference/android/arch/lifecycle/LiveData.html) -Introduction -------------- - ### Features This sample contains a single screen with a list of text items. Items can be added to the list with the input at the top, and swiping items in the list removes them. diff --git a/PagingWithNetworkSample/README.md b/PagingWithNetworkSample/README.md index cbcc76b3b..4cc7aba52 100644 --- a/PagingWithNetworkSample/README.md +++ b/PagingWithNetworkSample/README.md @@ -1,5 +1,7 @@ # Paging With Network Sample +Demos Paging library with a backend API, that is, the Reddit API. +## Introduction This sample demonstrates how to use the Paging library with a backend API (in this case [Reddit API][7]). @@ -63,4 +65,4 @@ in the API request response. It extends from the `PagingSource` class in the Pag [retrofit]: http://square.github.io/retrofit [glide]: https://github.com/bumptech/glide [mockito]: http://site.mockito.org -[retrofit-mock]: https://github.com/square/retrofit/tree/master/retrofit-mock \ No newline at end of file +[retrofit-mock]: https://github.com/square/retrofit/tree/master/retrofit-mock diff --git a/PersistenceMigrationsSample/README.md b/PersistenceMigrationsSample/README.md index 4403ace76..6b82d2a10 100644 --- a/PersistenceMigrationsSample/README.md +++ b/PersistenceMigrationsSample/README.md @@ -1,6 +1,7 @@ -Room Migration Sample -====================== +# Room Migration Sample +Demos database migrations using Room. +## Introduction This is an API sample to showcase how to deal with database migrations using Room. From [docs](https://developer.android.com/topic/libraries/architecture/room.html#db-migration): @@ -14,9 +15,6 @@ class specifies a startVersion and endVersion. At runtime, Room runs each [Migra class's [migrate()](https://developer.android.com/reference/android/arch/persistence/room/migration/Migration.html#migrate(android.arch.persistence.db.SupportSQLiteDatabase) method, using the correct order to migrate the database to a later version. -Introduction -------------- - ## Functionality The sample app shows an editable user name, stored in the database. diff --git a/ViewBindingSample/README.md b/ViewBindingSample/README.md index eecdfa64f..009212323 100644 --- a/ViewBindingSample/README.md +++ b/ViewBindingSample/README.md @@ -1,6 +1,9 @@ View Binding Sample ============================================= +Demos the Architecture Component View Binding. +Introduction +------------ This sample requires Android Studio 3.6+ and showcases the following Architecture Components: * [View Binding](https://developer.android.com/topic/libraries/view-binding) diff --git a/WorkManagerSample/README.md b/WorkManagerSample/README.md index a5d341e48..dd28ee01c 100644 --- a/WorkManagerSample/README.md +++ b/WorkManagerSample/README.md @@ -1,6 +1,7 @@ -Android Jetpack WorkManager Sample -================================== +# Android Jetpack WorkManager Sample +Demos WorkManager to do background work for a image processing app. +## Introduction This is a simple image processing application written in Kotlin that shows how to use [WorkManager](https://developer.android.com/topic/libraries/architecture/workmanager/) to do background work. ## Learn more about WorkManager