Color Pallet: Create README.md

Author: kavi707

README.md

@@ -1 +1,101 @@
-# KV Android Color Pallet
+# KV Android Color Pallet
+
+This is a lightweight Android library that generates a color palette from a given color and creates a theme color set for Android applications. 
+This library simplifies the process of building consistent and visually appealing color themes.
+
+# Features
+* Generate a color palette based on a single input color. Using color alpha/mat-colors
+* Create a complete theme color set, including primary, secondary, background, and surface colors.
+* Support for Material Design color guidelines.
+* Easy integration with Android projects.
+
+# Installation
+Add following in your root `build.gradle`/`build.gradle.kts` at the end of repositories:
+````
+dependencyResolutionManagement {
+	repositories {
+		mavenCentral()
+		maven { url 'https://jitpack.io' } // jitpack.io repository configured.
+	}
+}
+````
+
+Add the following dependency to your `build.gradle` / `build.gradle.kts` file:
+For Groovy - `build.gradle`:
+````
+dependencies {
+    implementation 'com.github.kavi707:kv-android-color-pallet:0.0.2'
+}
+````
+For Kotlin DSL - `build.gradle.kts`:
+````
+dependencies {
+    implementation("com.github.kavi707:kv-android-color-pallet:0.0.2")
+}
+````
+
+# Usage
+### Initiate 
+On usage of the kv-android-color-pallet, from your application class, Initiate it using following code.
+While initiating, you have to parse a color (androidx.compose.ui.graphics.Color) that you prefer to use as your primary color in your application.
+````
+override fun onCreate() {
+    super.onCreate()
+    // Initialize the kv-android-color-pallet
+    KvColorPallet.init(MatPackage.MatDGreen.color)
+}
+````
+This initiation create a color set for a theme using the given color at the initiation. 
+This generated color set available for light and dark theme variants.
+
+### Use generated theme
+As mentioned above, according to the initiation color, that generate the color set for light and dark them.
+In your Jetpack Compose project, you can assign generate color set the your application theme.
+````
+    // Access the generated theme color set from kv-android-color-pallet library
+    val theme = KvColorPallet.appThemePallet
+
+    // Generate application light theme using kv-android-color-pallet light colors
+    val themeLight = lightColorScheme(
+        primary = theme.light.primary,
+        secondary = theme.light.secondary,
+        tertiary = theme.light.tertiary,
+        background = theme.light.background,
+        onPrimary = theme.light.onPrimary,
+        onSecondary = theme.light.onSecondary
+    )
+
+    // Generate application dark theme using kv-android-color-pallet dark colors
+    val themeDark = darkColorScheme(
+        primary = theme.dark.primary,
+        secondary = theme.dark.secondary,
+        tertiary = theme.dark.tertiary,
+        background = theme.dark.background,
+        onPrimary = theme.dark.onPrimary,
+        onSecondary = theme.dark.onSecondary
+    )
+    
+    // Generate the color schema
+    val appColorScheme = when {
+        darkTheme -> themeDark
+        else -> themeLight
+    }
+
+    // Assign the color schema to the team.
+    MaterialTheme(
+        colorScheme = appColorScheme,
+        typography = AppTypography,
+        content = content
+    )
+````
+
+# Contribution
+We welcome contributions! Please fork the repository, make your changes, and submit a pull request. Ensure your code adheres to the established guidelines.
+
+# License
+kv-android-color-pallet is licensed under the [MIT License](https://github.com/kavi707/kv-android-color-pallet/blob/main/LICENSE).
+
+# Feedback
+For questions, suggestions, or issues, please open an issue on GitHub or contact us at kavimalw@gmail.com.
+
+

ui-app/src/main/kotlin/com/kavi/droid/color/pallet/app/theme/Theme.kt

@@ -54,8 +54,6 @@ fun KvColorPalletTheme(
         else -> themeLight
     }
 
-
-
     MaterialTheme(
         colorScheme = appColorScheme,
         typography = AppTypography,