diff --git a/README.md b/README.md index 8657914..b6f7798 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Build Status](https://img.shields.io/github/actions/workflow/status/RedMadRobot/gears-android/main.yml?branch=main&style=flat-square)][ci] [![License](https://img.shields.io/github/license/RedMadRobot/gears-android?style=flat-square)][license] -**Gears** — small libraries used in red_mad_robot to build awesome Android applications. +**Gears** – small libraries used in red_mad_robot to build awesome Android applications. Gears could be used together or alone. --- @@ -19,19 +19,19 @@ Gears could be used together or alone. ## Libraries -### :gear: **[gears](gears/)** +### :gear: **[Gears](gears/)** -- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.gears/gears-compose?style=flat-square)][compose-gears] - A set of gears for Jetpack Compose -- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.gears/kotlin?style=flat-square)][kotlin-gears] - A set of gears for Kotlin +- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.gears/gears-compose?style=flat-square)][gears-compose] — A set of gears for Jetpack Compose +- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.gears/kotlin?style=flat-square)][gears-kotlin] — A set of gears for Kotlin ### :hammer_and_wrench: **[red_mad_robot Android KTX](ktx/)** -- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.extensions/core-ktx?style=flat-square&label=core-ktx)][core-ktx] - Extensions in addition to androidx core-ktx -- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.extensions/fragment-ktx?style=flat-square&label=fragment-ktx)][fragment-ktx] - A set of extensions in addition to androidx fragment-ktx -- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.extensions/fragment-args-ktx?style=flat-square&label=fragment-args-ktx)][fragment-args-ktx] - Delegates for safe dealing with fragments' arguments -- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.extensions/lifecycle-livedata-ktx?style=flat-square&label=lifecycle-livedata-ktx)][lifecycle-livedata-ktx] - Extended set of extensions for dealing with `LiveData` -- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.extensions/resources-ktx?style=flat-square&label=resources-ktx)][resources-ktx] - A set of extensions for accessing resources -- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.extensions/viewbinding-ktx?style=flat-square&label=viewbinding-ktx)][viewbinding-ktx] - A set of extensions for dealing with ViewBinding +- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.extensions/core-ktx?style=flat-square&label=core-ktx)][core-ktx] — Extensions in addition to androidx core-ktx +- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.extensions/fragment-ktx?style=flat-square&label=fragment-ktx)][fragment-ktx] — A set of extensions in addition to androidx fragment-ktx +- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.extensions/fragment-args-ktx?style=flat-square&label=fragment-args-ktx)][fragment-args-ktx] — Delegates for safe dealing with fragments' arguments +- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.extensions/lifecycle-livedata-ktx?style=flat-square&label=lifecycle-livedata-ktx)][lifecycle-livedata-ktx] — Extended set of extensions for dealing with `LiveData` +- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.extensions/resources-ktx?style=flat-square&label=resources-ktx)][resources-ktx] — A set of extensions for accessing resources +- [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.extensions/viewbinding-ktx?style=flat-square&label=viewbinding-ktx)][viewbinding-ktx] — A set of extensions for dealing with ViewBinding ### :mag_right: **[ViewModelEvents](viewmodelevents/)** @@ -45,8 +45,8 @@ A couple of extensions to convert long operations into `Flow>`. ## Why Gears? -The goal of this monorepository is to simplify creation and publication of libraries. -These libraries, which we are calling "gears," are small but important parts of our tech stack that we want to share between our projects. +The goal of this mono-repository is to simplify the creation and publication of libraries. +These libraries, which we're calling "gears," are small but important parts of our tech stack that we want to share between our projects. Libraries may be initially developed here and then moved out from this repository as part of their lifecycle. Large libraries or those with unique build infrastructure should be moved into a separate repository. @@ -54,7 +54,7 @@ Large libraries or those with unique build infrastructure should be moved into a ## Contribution Merge requests are welcome. -For major changes, please open a [discussion][discussions] first to discuss what you would like to change. +For major changes, open a [discussion][discussions] first to discuss what you would like to change. ## License @@ -68,8 +68,8 @@ For major changes, please open a [discussion][discussions] first to discuss what [viewbinding-ktx]: ktx/viewbinding-ktx/ [license]: LICENSE -[compose-gears]: gears/gears-compose -[kotlin-gears]: gears/gears-kotlin +[gears-compose]: gears/gears-compose +[gears-kotlin]: gears/gears-kotlin [viewmodelevents-compose]: viewmodelevents/viewmodelevents-compose/ [viewmodelevents-flow]: viewmodelevents/viewmodelevents-flow/