Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates README files to work properly with studio and sample page #970

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
5 changes: 2 additions & 3 deletions BasicRxJavaSample/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
5 changes: 2 additions & 3 deletions BasicRxJavaSampleKotlin/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
5 changes: 2 additions & 3 deletions BasicSample/README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
5 changes: 2 additions & 3 deletions GithubBrowserSample/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
5 changes: 2 additions & 3 deletions LiveDataSample/README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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
Expand Down
4 changes: 3 additions & 1 deletion MADSkillsNavigationSample/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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.
the License.
5 changes: 3 additions & 2 deletions NavigationAdvancedSample/README.md
Original file line number Diff line number Diff line change
@@ -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).

Expand Down
2 changes: 2 additions & 0 deletions NavigationBasicSample/README.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
5 changes: 2 additions & 3 deletions PagingSample/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
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)
* [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 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.
Expand Down
4 changes: 3 additions & 1 deletion PagingWithNetworkSample/README.md
Original file line number Diff line number Diff line change
@@ -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]).

Expand Down Expand Up @@ -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
[retrofit-mock]: https://github.com/square/retrofit/tree/master/retrofit-mock
8 changes: 3 additions & 5 deletions PersistenceMigrationsSample/README.md
Original file line number Diff line number Diff line change
@@ -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):

Expand All @@ -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.

Expand Down
3 changes: 3 additions & 0 deletions ViewBindingSample/README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
5 changes: 3 additions & 2 deletions WorkManagerSample/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down