add example module and update documentation

Author: MadFlasheroo7

CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Contributing to Madifiers
+Madifiers is an open source project for the community. We invite your participation through issues, and pull requests!
+
+# Ways to Contribute
+You can contribute by optimizing existing code or adding more libraries can checkout a sample module 
+[here](/madifiers-example) or opening issues.
+
+# Preparing a pull request for review
+Ensure to maintain the project structure:
+
+if adding more features to new category
+```
+├── madifiers-<category>
+│   ├── module name 
+```
+and for existing categories add modules to the respective category 
+and ensure your code is properly formatted by running:
+```bash
+./gradlew spotlessApply
+```
+---
+And Thank you for considering contributing to madifiers 💚 

README.md

@@ -1,32 +1,53 @@
 ![banner art](/art/banner%20art%20-%20madifiers.png)
 
 # What is *Madifiers*?
-
 Madifiers is bunch of pre-made composable, modifiers, extension functions etc...
 Basically Anything and everything to make jetpack compose development easy and straight forward
 
-# Features
-- [Bionic Text](/text/bionicText)
-- [Animate TextUnit](/text/animateTextUnitAsState)
-- [Window Info](/window/windowUtils)
+# Libraries
+## [Bionic Text](/madifiers-text/bionicText) - ![Maven Central](https://img.shields.io/maven-central/v/pro.jayeshseth.madifiers/windowUtils?style=flat-square)
+applies bionic reading affect on text
+
+## [AnimateTextUnitAsState](/madifiers-text/animateTextUnitAsState) - ![Maven Central](https://img.shields.io/maven-central/v/pro.jayeshseth.madifiers/animateTextUnitAsState?style=flat-square)
+animates text units like `sp` and `em` to the provided target value
+
+## [Window Util](/madifiers-window/windowUtils) - ![Maven Central](https://img.shields.io/maven-central/v/pro.jayeshseth.madifiers/windowUtils?style=flat-square)
+window utils to get usable screen height, width and more in `dp` and `px`
 
 # Project Structure
-```kotlin
-TODO()
+```
+Madifiers                         # Root Project
+├── app                           # Sample App showcasing library usage
+├── art                           # contains screenshots and videos of the library usage 
+├── build-logic                   # contains conventional plugins to mitigate code duplication
+├── buildSrc                      # used to manage versioning of modules
+├── scripts                       # contains scripts to publish modules to maven central
+│
+├── madifiers-example             # an example module for developers to help contribute new modules
+├── madifiers-text                # directory for all text or string related modules 
+│   ├── animateTextUnitAsState    # animates text units like sp and em to the provided target value
+│   ├── bionicText                # applies bionic reading affect on text 
+│   ├── extensions                # TODO
+│
+├── madifiers-window              # directory for window related modules 
+│   ├── windowUtils               # window utils to get usable screen height, width and more in dp and px 
 ```
 
+# Blog 
+You can check out how madifiers came to life and make your own single or multi module library
+for android and publish it to maven central here(coming soon)
+
 # How & Why "Madifiers"?
-When i first tried and learned jetpack compose and on **June 5th, 2021** and was learning about "modifiers",
-my brain went "more like madifiers" so since then i wanted to build a library for compose and name it 
-"Madifiers" and when i saw [Super Extension](https://github.com/AbhishekDoshi26/super_extensions) for flutter 
-by Abhishek Doshi and [VelocityX](https://velocityx.dev/) by pawan kumar. So, I got an idea of why 
-not make a library with bunch of modifier, extensions, and composables for jetpack compose. 
-And that's how **Madifiers** came into into life.
-
-# Contribute
-```kotlin
-TODO()
-```
+On **June 5th, 2021** while learning about "modifiers" in jetpack compose, I had a thought that the 
+term "modifiers" could be playfully referred to as **"madifiers"**. This sparked an idea to create a
+library for jetpack compose, which i would name **"Madifiers"**. After discovering libraries like
+[Super Extension](https://github.com/AbhishekDoshi26/super_extensions) by Abhishek Doshi and 
+[VelocityX](https://velocityx.dev/) by pawan kumar, I was inspired to create a library that would include
+a collection of modifiers, extensions and composables which makes jetpack compose development easy and 
+straight forward. Thus, Madifiers was born.
+
+# Contribution
+Learn about contribution [here](/CONTRIBUTING.md).
 
 # License
 ```

app/src/androidTest/java/pro/jayeshseth/madifiers/ExampleInstrumentedTest.kt

@@ -1,10 +1,25 @@
+/*
+ * Copyright 2023 Jayesh Seth
+ *
+ * Licensed 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
+ * 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.
+ */
 package pro.jayeshseth.madifiers
 
-import androidx.test.platform.app.InstrumentationRegistry
 import androidx.test.ext.junit.runners.AndroidJUnit4
+import androidx.test.platform.app.InstrumentationRegistry
+import org.junit.Assert.assertEquals
 import org.junit.Test
 import org.junit.runner.RunWith
-import org.junit.Assert.*
 
 /**
  * Instrumented test, which will execute on an Android device.
@@ -13,10 +28,10 @@ import org.junit.Assert.*
  */
 @RunWith(AndroidJUnit4::class)
 class ExampleInstrumentedTest {
-    @Test
-    fun useAppContext() {
-        // Context of the app under test.
-        val appContext = InstrumentationRegistry.getInstrumentation().targetContext
-        assertEquals("in.realogs.madifiers", appContext.packageName)
-    }
-}
+  @Test
+  fun useAppContext() {
+    // Context of the app under test.
+    val appContext = InstrumentationRegistry.getInstrumentation().targetContext
+    assertEquals("in.realogs.madifiers", appContext.packageName)
+  }
+}

app/src/main/java/pro/jayeshseth/madifiers/MainActivity.kt

@@ -1,3 +1,18 @@
+/*
+ * Copyright 2023 Jayesh Seth
+ *
+ * Licensed 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
+ * 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.
+ */
 package pro.jayeshseth.madifiers
 
 import android.os.Bundle
@@ -13,27 +28,27 @@ import pro.jayeshseth.bionicText.BionicText
 import pro.jayeshseth.madifiers.ui.theme.MadifiersTheme
 
 class MainActivity : ComponentActivity() {
-    override fun onCreate(savedInstanceState: Bundle?) {
-        super.onCreate(savedInstanceState)
-        setContent {
-            MadifiersTheme {
-                // A surface container using the 'background' color from the theme
-                Surface(
-                    modifier = Modifier.fillMaxSize(),
-                    color = MaterialTheme.colorScheme.background
-                ) {
-                    Greeting("Android")
-                }
-            }
+  override fun onCreate(savedInstanceState: Bundle?) {
+    super.onCreate(savedInstanceState)
+    setContent {
+      MadifiersTheme {
+        // A surface container using the 'background' color from the theme
+        Surface(
+          modifier = Modifier.fillMaxSize(),
+          color = MaterialTheme.colorScheme.background,
+        ) {
+          Greeting("Android")
         }
+      }
     }
+  }
 }
 
 @Composable
 fun Greeting(name: String, modifier: Modifier = Modifier) {
-    BionicText(text = "hi there")
-    Text(
-        text = "Hello $name!",
-        modifier = modifier
-    )
+  BionicText(text = "hi there")
+  Text(
+    text = "Hello $name!",
+    modifier = modifier,
+  )
 }

app/src/main/java/pro/jayeshseth/madifiers/ui/screens/AnimateTextUnit.kt

@@ -1,3 +1,18 @@
+/*
+ * Copyright 2023 Jayesh Seth
+ *
+ * Licensed 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
+ * 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.
+ */
 package pro.jayeshseth.madifiers.ui.screens
 
 import androidx.compose.animation.core.LinearEasing
@@ -27,74 +42,74 @@ import pro.jayeshseth.madifiers.ui.theme.MadifiersTheme
 
 @Composable
 fun AnimateTextUnitScreen() {
-    var animateTween by remember { mutableStateOf(true) }
-    var animateSpring by remember { mutableStateOf(true) }
+  var animateTween by remember { mutableStateOf(true) }
+  var animateSpring by remember { mutableStateOf(true) }
 
-    val textSizeTween by animateTextUnitAsState(
-        targetValue =  if (animateTween) 30.sp else 16.sp,
-        animationSpec = tween(
-            durationMillis = 1000,
-            easing = LinearEasing
-        )
+  val textSizeTween by animateTextUnitAsState(
+    targetValue = if (animateTween) 30.sp else 16.sp,
+    animationSpec = tween(
+      durationMillis = 1000,
+      easing = LinearEasing,
+    ),
+  )
+  val textSizeSpring by animateTextUnitAsState(
+    targetValue = if (animateSpring) 30.sp else 16.sp,
+    animationSpec = spring(
+      dampingRatio = Spring.DampingRatioHighBouncy,
+      stiffness = Spring.StiffnessLow,
+    ),
+  )
+
+  Column {
+    TextCard(
+      text = "Animate Text - tween",
+      onClick = { animateTween = !animateTween },
+      fontSize = textSizeTween,
     )
-    val textSizeSpring by animateTextUnitAsState(
-        targetValue =  if (animateSpring) 30.sp else 16.sp,
-        animationSpec = spring(
-            dampingRatio = Spring.DampingRatioHighBouncy,
-            stiffness = Spring.StiffnessLow
-        )
+    TextCard(
+      text = "Animate Text - spring",
+      onClick = { animateSpring = !animateSpring },
+      fontSize = textSizeSpring,
     )
-
-    Column {
-        TextCard(
-            text = "Animate Text - tween",
-            onClick = { animateTween = !animateTween },
-            fontSize = textSizeTween
-        )
-        TextCard(
-            text = "Animate Text - spring",
-            onClick = { animateSpring = !animateSpring },
-            fontSize = textSizeSpring
-        )
-    }
+  }
 }
 
 @Composable
 fun TextCard(
-    text: String,
-    fontSize: TextUnit = 16.sp,
-    onClick: () -> Unit
+  text: String,
+  fontSize: TextUnit = 16.sp,
+  onClick: () -> Unit,
 ) {
-    Card(modifier = Modifier.padding(8.dp)) {
-        Column(
-            Modifier
-                .fillMaxWidth()
-                .padding(8.dp),
-            horizontalAlignment = Alignment.CenterHorizontally
-        ) {
-            Text(
-                text = text,
-                fontSize = fontSize,
-                style = MaterialTheme.typography.titleLarge,
-                modifier = Modifier.padding(20.dp)
-            )
-            Button(onClick = onClick, modifier = Modifier.fillMaxWidth()) {
-                Text(text = "Change Size")
-            }
-        }
+  Card(modifier = Modifier.padding(8.dp)) {
+    Column(
+      Modifier
+        .fillMaxWidth()
+        .padding(8.dp),
+      horizontalAlignment = Alignment.CenterHorizontally,
+    ) {
+      Text(
+        text = text,
+        fontSize = fontSize,
+        style = MaterialTheme.typography.titleLarge,
+        modifier = Modifier.padding(20.dp),
+      )
+      Button(onClick = onClick, modifier = Modifier.fillMaxWidth()) {
+        Text(text = "Change Size")
+      }
     }
+  }
 }
 
 @Preview(showBackground = true)
 @Composable
 fun PreviewTextCard() {
-    TextCard(text = "Text Size", onClick = {})
+  TextCard(text = "Text Size", onClick = {})
 }
 
 @Preview
 @Composable
 fun PreviewAnimateTextUnitScreen() {
-    MadifiersTheme {
-        AnimateTextUnitScreen()
-    }
-}
+  MadifiersTheme {
+    AnimateTextUnitScreen()
+  }
+}