Skip to content

Commit

Permalink
docs: Stylistic changes in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
osipxd committed Jul 30, 2024
1 parent 88a638a commit 92a4bbf
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

---
Expand All @@ -19,36 +19,36 @@ 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

### :hourglass_flowing_sand: **[Result Flow](resultflow/)** [![Version](https://img.shields.io/maven-central/v/com.redmadrobot.gears/resultflow?style=flat-square)]

A couple of extensions to convert long operations into `Flow<Result<T>>`.

## 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.

## 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

Expand All @@ -62,8 +62,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

[ci]: https://github.com/RedMadRobot/gears-android/actions?query=branch%3Amain++
[discussions]: https://github.com/RedMadRobot/gears-android/discussions

0 comments on commit 92a4bbf

Please sign in to comment.