From 7c165316598d1a1be813a3ac9acfb8c2650aa033 Mon Sep 17 00:00:00 2001
From: Osip Fatkullin <o.fatkullin@redmadrobot.com>
Date: Fri, 17 May 2024 17:22:28 +0200
Subject: [PATCH] docs: Add readme

---
 README.md     | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 ktx/README.md | 23 +++++++----------------
 2 files changed, 57 insertions(+), 16 deletions(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..12277b3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+# Gears :gear:
+
+ [![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 could be used together or alone.
+
+---
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [Libraries](#libraries)
+- [Contribution](#contribution)
+- [License](#license)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Libraries
+
+> [!TIP]
+> Click on a badge to open library documentation.
+
+- :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
+
+## Contribution
+
+Merge requests are welcome.
+For major changes, please open a [discussion][discussions] first to discuss what you would like to change.
+
+## License
+
+[MIT][license]
+
+[core-ktx]: ktx/core-ktx/
+[fragment-ktx]: ktx/fragment-ktx/
+[fragment-args-ktx]: ktx/fragment-args-ktx/
+[lifecycle-livedata-ktx]: ktx/lifecycle-livedata-ktx/
+[resources-ktx]: ktx/resources-ktx/
+[viewbinding-ktx]: ktx/viewbinding-ktx/
+[license]: LICENSE
+
+[ci]: https://github.com/RedMadRobot/gears-android/actions
+[discussions]: https://github.com/RedMadRobot/gears-android/discussions
diff --git a/ktx/README.md b/ktx/README.md
index acf4c3d..1b08dd1 100644
--- a/ktx/README.md
+++ b/ktx/README.md
@@ -1,10 +1,11 @@
-# Redmadrobot Android KTX
- [![Build Status](https://img.shields.io/github/workflow/status/RedMadRobot/gears-android/CI/main?style=flat-square)][ci]
- [![License](https://img.shields.io/github/license/RedMadRobot/gears-android?style=flat-square)][license]
+# red_mad_robot Android KTX
+
+[![License](https://img.shields.io/github/license/RedMadRobot/gears-android?style=flat-square)][license]
 
 Missing Android KTX extensions.
 
-> :exclamation: It is not replacement of [Android KTX][ktx], it is just additional extensions and delegates that we found useful.
+> [!IMPORTANT]
+> It is not a replacement of [Android KTX][ktx], it is just additional extensions and delegates that we found useful.
 
 ---
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
@@ -20,7 +21,8 @@ Missing Android KTX extensions.
 
 ## Modules
 
-Module's pages contain README with detailed description of module.
+> [!TIP]
+> Click on a badge to open library documentation.
 
 - [![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
@@ -41,15 +43,6 @@ com.redmadrobot.extensions:fragment-args-ktx:2.2.0-0
 - `2.2.0` - version of `androidx.fragment:fragment`
 - `0` - version of extensions. First version of extensions for `fragment:2.2.0`
 
-## Contribution
-
-Merge requests are welcome.
-For major changes, please open a [discussion][discussions] first to discuss what you would like to change.
-
-## License
-
-[MIT][license]
-
 [ktx]: https://developer.android.com/kotlin/ktx
 
 [core-ktx]: core-ktx
@@ -58,6 +51,4 @@ For major changes, please open a [discussion][discussions] first to discuss what
 [lifecycle-livedata-ktx]: lifecycle-livedata-ktx
 [resources-ktx]: resources-ktx
 [viewbinding-ktx]: viewbinding-ktx
-[ci]: https://github.com/RedMadRobot/gears-android/actions
-[discussions]: https://github.com/RedMadRobot/gears-android/discussions
 [license]: ../LICENSE