diff --git a/README.md b/README.md index a58265c6..4c081494 100644 --- a/README.md +++ b/README.md @@ -1,75 +1,71 @@ Android Architecture Components samples =================================== -A collection of samples using the [Architecture Components](https://developer.android.com/arch): +A collection of samples using the **[Architecture Components](https://developer.android.com/arch)**: -- [Room](https://developer.android.com/topic/libraries/architecture/room) -- [Lifecycle-aware components](https://developer.android.com/topic/libraries/architecture/lifecycle) -- [ViewModels](https://developer.android.com/topic/libraries/architecture/viewmodel) -- [LiveData](https://developer.android.com/topic/libraries/architecture/livedata) -- [Paging](https://developer.android.com/topic/libraries/architecture/paging/) -- [Navigation](https://developer.android.com/topic/libraries/architecture/navigation/) -- [ViewBinding](https://developer.android.com/topic/libraries/view-binding) -- [WorkManager](https://developer.android.com/topic/libraries/architecture/workmanager/) +- **[Room.](https://developer.android.com/topic/libraries/architecture/room)** +- **[Lifecycle-aware components.](https://developer.android.com/topic/libraries/architecture/lifecycle)** +- **[ViewModels.](https://developer.android.com/topic/libraries/architecture/viewmodel)** +- **[LiveData.](https://developer.android.com/topic/libraries/architecture/livedata)** +- **[Paging.](https://developer.android.com/topic/libraries/architecture/paging/)** +- **[Navigation.](https://developer.android.com/topic/libraries/architecture/navigation/)** +- **[ViewBinding.](https://developer.android.com/topic/libraries/view-binding)** +- **[WorkManager.](https://developer.android.com/topic/libraries/architecture/workmanager/)** -### Samples +# Samples -* **[BasicSample](https://github.com/googlesamples/android-architecture-components/blob/master/BasicSample)** - Shows how to persist data using a SQLite database and Room. Also uses ViewModels and LiveData. +* **[BasicSample](https://github.com/googlesamples/android-architecture-components/blob/master/BasicSample)** - Shows how to persist data using a `SQLite` database and `Room`. Also uses `ViewModel` and `LiveData`. -* **[PersistenceContentProviderSample](https://github.com/googlesamples/android-architecture-components/blob/master/PersistenceContentProviderSample)** - Shows how to expose data via a Content Provider using Room. +* **[PersistenceContentProviderSample](https://github.com/googlesamples/android-architecture-components/blob/master/PersistenceContentProviderSample)** - Shows how to expose data via a `Content Provider` using `Room`. -* **[GithubBrowserSample](https://github.com/googlesamples/android-architecture-components/blob/master/GithubBrowserSample)** - An **advanced** sample that uses the Architecture components, Dagger and the Github API, in Kotlin. +* **[GithubBrowserSample](https://github.com/googlesamples/android-architecture-components/blob/master/GithubBrowserSample)** - An **advanced** sample that uses the Architecture components, `Dagger` and the `Github API`, in `Kotlin`. -* **[BasicRxJavaSample](https://github.com/googlesamples/android-architecture-components/blob/master/BasicRxJavaSample)** - Shows how to use Room with RxJava 2. Also uses ViewModels. +* **[BasicRxJavaSample](https://github.com/googlesamples/android-architecture-components/blob/master/BasicRxJavaSample)** - Shows how to use `Room` with `RxJava 2`. Also uses `ViewModel`. -* **[PersistenceMigrationsSample](https://github.com/googlesamples/android-architecture-components/blob/master/PersistenceMigrationsSample)** - Shows how to implement migrations in Room. +* **[PersistenceMigrationsSample](https://github.com/googlesamples/android-architecture-components/blob/master/PersistenceMigrationsSample)** - Shows how to implement migrations in `Room`. * **[BasicRxJavaKotlinSample](https://github.com/googlesamples/android-architecture-components/blob/master/BasicRxJavaSampleKotlin)** - Shows -how to use ViewModels and Room together with RxJava, in Kotlin. +how to use `ViewModel` and `Room` together with `RxJava`, in `Kotlin`. * **[PagingSample](https://github.com/googlesamples/android-architecture-components/tree/master/PagingSample)** - Shows - how to use the Paging library with Room, in Kotlin. + how to use the Paging library with `Room`, in `Kotlin`. * **[PagingNetworkSample](https://github.com/googlesamples/android-architecture-components/tree/master/PagingWithNetworkSample)** - Shows - how to use the Paging library with a backend API via Retrofit, in Kotlin. + how to use the Paging library with a backend `API` via `Retrofit`, in `Kotlin`. * **[NavigationBasicSample](https://github.com/googlesamples/android-architecture-components/tree/master/NavigationBasicSample)** - Shows - how to use Navigation to perform navigation and deep linking in Kotlin. + how to use `Navigation` to perform navigation and deep linking in `Kotlin`. * **[NavigationAdvancedSample](https://github.com/googlesamples/android-architecture-components/tree/master/NavigationAdvancedSample)** - Shows - how to handle multiple back stacks with Navigation and a BottomNavigationView. + how to handle multiple back stacks with `Navigation` and a `BottomNavigationView`. * **[LiveDataSample](https://github.com/googlesamples/android-architecture-components/tree/master/LiveDataSample)** - Shows - how to integrate Kotlin coroutines with Architecture Components such as `LiveData`. + how to integrate `Kotlin` coroutines with `Architecture Components` such as `LiveData`. -* **[ViewBindingSample](https://github.com/googlesamples/android-architecture-components/tree/master/ViewBindingSample)** - Shows how to use view bindings in an activity and in fragments. +* **[ViewBindingSample](https://github.com/googlesamples/android-architecture-components/tree/master/ViewBindingSample)** - Shows how to use view bindings in an `Activity` and in `Fragments`. * **[WorkManagerSample](https://github.com/googlesamples/android-architecture-components/tree/master/WorkManagerSample)** - Shows - how to use WorkManager to do background work, in Kotlin. + how to use `WorkManager` to do background work, in `Kotlin`. -* **[WorkManagerMultiprocessSample](https://github.com/googlesamples/android-architecture-components/tree/master/WorkManagerMultiprocessSample)** - Shows how to use WorkManager in apps that manage multiple processes. +* **[WorkManagerMultiprocessSample](https://github.com/googlesamples/android-architecture-components/tree/master/WorkManagerMultiprocessSample)** - Shows how to use `WorkManager` in apps that manage multiple processes. -### Reporting Issues +# Reporting Issues -You can report an [Issue](https://github.com/googlesamples/android-architecture-components/issues) on the samples using this repository. If you find an issue with the Architecture Components, report it using the [Architecture Components Issue Tracker](https://issuetracker.google.com/issues/new?component=197448&template=878802) +You can report an **[Issue](https://github.com/googlesamples/android-architecture-components/issues)** on the samples using this repository. If you find an issue with the Architecture Components, report it using the **[Architecture Components Issue Tracker.](https://issuetracker.google.com/issues/new?component=197448&template=878802)** License ------- -Copyright 2018 The Android Open Source Project, Inc. +**Copyright 2018 The Android Open Source Project, Inc.** -Licensed to the Apache Software Foundation (ASF) under one or more contributor +**Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of -the License at - -http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software +the License **[here](http://www.apache.org/licenses/LICENSE-2.0)**. 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.**