Merge pull request #20 from monstar-lab-oss/docs/release-preparation

docs: Release preparation

Author: levinzonr

.github/workflows/docs.yml

@@ -31,6 +31,5 @@ jobs:
       - run: |
           chmod +x ./generate_docs.sh
           ./generate_docs.sh
-
       - run: pip install mkdocs-material
       - run: mkdocs gh-deploy --force

.gitignore

@@ -8,7 +8,13 @@
 /.idea/workspace.xml
 /.idea/navEditor.xml
 /.idea/assetWizardSettings.xml
+<<<<<<< HEAD
+/.idea/misc.xml
+/.idea/deploymentTargetDropDown.xml
+/.idea/deploymentTargetSelector.xml
+=======
 /.idea/*
+>>>>>>> origin/main
 .DS_Store
 /build
 /captures
@@ -17,5 +23,9 @@
 local.properties
 /build-logic/convention/build/
 
-# generated dokka files just, ignored just in case
-/docs/api/
+# Documentation not to be modified by hand (pulled from root project)
+docs/index.md
+docs/changelog.md
+docs/contributing.md
+docs/license.md
+docs/api/*

CHANGELOG.md

@@ -7,12 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-
-## [0.0.1] - 2024-03-27
-
 ### Added
+With our first Mosaic Release 🎉 we introduce the first compoment that makes it to the Mosaic Collection: Mosaic Slider.
 
+Mosaic Slider offers a wide range of customization including custom Thumbs, custom Values Distribution and more
 
 
-## [0.0.0]
-### Added
+You can learn more about Mosaic on our [documentation page](https://monstar-lab-oss.github.io/android-mosaic/)

CONTRIBUTING.md

@@ -0,0 +1,23 @@
+# How to Contribute
+
+We'd love to accept your patches and contributions to Mosaic, wether its a new component / tool or an update to existing ones! There are
+just a few small guidelines you need to follow :) 
+
+## New Features/Libraries
+
+Before contributing large new features and/or library please reach out with discussion first.
+## Code Reviews
+
+All submissions, including submissions by project members, require review. We
+use GitHub pull requests for this purpose. Consult
+[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
+information on using pull requests.
+
+### CI/CD Checks
+We have a GitHub Actions workflow that is being activated as part of any raised Pull Request, it will run the tests, spotless and detekt checks.
+
+You can also run this locally to make sure the PR will pass these checks:
+
+- Spotless: Run `./gradlew spotlessApply` to apply formatting to the code according to the spec. 
+
+- Detekt: Run `./gradlew detekt` to run static code analysis using Detekt.

README.md

@@ -1,14 +1,32 @@
 # Mosaic
-Collection of UI components and utilities for Jetpack Compose
-
-## TODOS
-- [x] Project setup
-- [x] Convention Plugins
-- [ ] Sonarqube
-- [x] CI/CD and PR validation, Spotless, Detekt, tests
-- [ ] Release management, 
-  - [x] Maven Publish
-  - [ ] Changelog
-  - [ ] Tags & Releases
-- [x] Documentation setup
 
+
+<p align="center">
+  <img src="./docs/assets/logo.svg" alt="Mosaic Logo" width="300"/>
+</p>
+
+<p align="center" style="font-size: 15px;">
+  <strong>Mosaic</strong> is acollection of Jetpack Compose UI components and utilities. It is designed to accelerate the development process by providing a rich set of tools and components that are ready to use out of the box. These components are highly customizable ensuring to fit in your use case. 
+</p>
+
+
+## Libraries
+
+### 🎛️ [Mosaic Slider](./slider/)
+Mosaic Slider is a highly customizable slider component that allows precise customization of values distribution and disabled ranges. Its API is similar to Material sliders, making it easy to integrate into existing projects.
+
+
+
+## Contributing
+
+We welcome contributions! Please see our [contributing guidelines](CONTRIBUTING.md) for more details.
+
+## License
+
+Mosaic is licensed under the MIT License. See [LICENSE](LICENSE) for more details.
+
+
+## Made with ❤️ by
+<p>
+  <img src="./docs/assets/ml_logo.png" alt="Monstarlab Logo" width="300"/>
+</p>

build-logic/convention/build.gradle.kts

@@ -12,6 +12,10 @@ dependencies {
     compileOnly(lib.android.gradle.plugin)
 }
 
+kotlin {
+    jvmToolchain(17)
+}
+
 gradlePlugin {
     /**
      * Register convention plugins so they are available in the build scripts of the application

demo/src/main/java/io/monstarlab/mosaic/features/SliderDemo.kt

@@ -39,8 +39,8 @@ import androidx.compose.ui.tooling.preview.Preview
 import androidx.compose.ui.unit.dp
 import io.monstarlab.mosaic.slider.Slider
 import io.monstarlab.mosaic.slider.SliderColors
-import io.monstarlab.mosaic.slider.distribution.CheckPointsValueDistribution
-import io.monstarlab.mosaic.slider.distribution.SliderValueDistribution
+import io.monstarlab.mosaic.slider.distribution.CheckPointsValuesDistribution
+import io.monstarlab.mosaic.slider.distribution.SliderValuesDistribution
 import kotlin.math.roundToInt
 import androidx.compose.material3.Slider as MaterialSlider
 
@@ -83,8 +83,8 @@ fun MosaicSliderDemo() {
             Modifier
         }
 
-        val fragmentedDistribution: SliderValueDistribution = remember {
-            CheckPointsValueDistribution(
+        val fragmentedDistribution: SliderValuesDistribution = remember {
+            CheckPointsValuesDistribution(
                 listOf(
                     0f to 0f,
                     0.2f to 500f,
@@ -100,10 +100,11 @@ fun MosaicSliderDemo() {
             modifier = modifier,
             enabled = enabled,
             colors = colors,
+
             range = 0f..1000f,
             disabledRange = 50f..300f,
             valueDistribution = if (linearDistribution) {
-                SliderValueDistribution.Linear
+                SliderValuesDistribution.Linear
             } else {
                 fragmentedDistribution
             },

demo/src/main/java/io/monstarlab/mosaic/ui/theme/Theme.kt

@@ -39,18 +39,9 @@ fun MosaicTheme(
     dynamicColor: Boolean = true,
     content: @Composable () -> Unit,
 ) {
-    val colorScheme = when {
-        dynamicColor && Build.VERSION.SDK_INT >= Build.VERSION_CODES.S -> {
-            val context = LocalContext.current
-            if (darkTheme) dynamicDarkColorScheme(context) else dynamicLightColorScheme(context)
-        }
-
-        darkTheme -> DarkColorScheme
-        else -> LightColorScheme
-    }
 
     MaterialTheme(
-        colorScheme = colorScheme,
+        colorScheme = DarkColorScheme,
         typography = Typography,
         content = content,
     )