v1.2.0

Author: tharukackh

.github/workflows/publish.yml

@@ -7,7 +7,7 @@ on:
   workflow_dispatch:
     inputs:
       tag:
-        description: Existing release tag, for example v1.1.0
+        description: Existing release tag, for example v1.2.0
         required: true
         type: string
 
@@ -102,7 +102,7 @@ jobs:
         run: |
           gh release create "$RELEASE_TAG" \
             --verify-tag \
-            --title "GuideKit $PROJECT_VERSION" \
+            --title "GuideKit Compose $PROJECT_VERSION" \
             --notes-file release-notes.md \
             --latest
         env:

CHANGELOG.md

@@ -1,9 +1,23 @@
 # Changelog
 
-All notable changes to GuideKit will be documented in this file.
+All notable changes to GuideKit Compose will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project follows semantic versioning.
 
+## [1.2.0] - 2026-08-24
+
+### Library changes
+
+- Updated Compose Multiplatform runtime, UI, and foundation dependencies from `1.10.0` to `1.11.1`.
+- Removed the unused Material Icons Extended dependency, reducing the library's dependency footprint.
+- Renamed the published Maven display name to GuideKit Compose while preserving the existing `io.github.tharukack:guidekit` coordinate and public Kotlin APIs.
+
+### Project and documentation
+
+- Renamed the public-facing product from GuideKit to GuideKit Compose across the README, documentation website, sample application, release titles, and package metadata.
+- Added an explicit requirements and compatibility table covering Kotlin, Compose Multiplatform, Material 3, Android `minSdk`, and supported iOS architectures.
+- Refreshed the documentation banner, social preview, screenshots, and animated demos with the GuideKit Compose branding.
+
 ## [1.1.0] - 2026-07-23
 
 ### Library changes
@@ -17,7 +31,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 - Expanded the sample tours with global theme demonstrations, arrow line and anchor variants, repeated targets, top-positioned instructions, arrow-free steps, and circular target highlights.
 - Moved the sample guides to the full-screen parent so overlays render above the smaller bottom navigation and the complete screen content.
 - Updated the README and website examples, customization guide, and API reference for the new step-override behavior.
-- Refreshed the documentation website with the latest demo GIFs and screenshots, a real-flow gallery, the GuideKit favicon, larger syntax-highlighted Kotlin examples, and improved mobile navigation and responsive layouts.
+- Refreshed the documentation website with the latest demo GIFs and screenshots, a real-flow gallery, the GuideKit Compose favicon, larger syntax-highlighted Kotlin examples, and improved mobile navigation and responsive layouts.
 
 ## [1.0.0] - 2026-07-22
 
@@ -26,15 +40,15 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 - Expanded the README with the same installation, full-screen parent setup, target-bounds callback, persistence, customization, and API guidance used by the website.
 - Replaced public arrow dash interval arrays with named presets directly in `GuideKitArrowLineStyle`: `Dotted`, `ShortDash`, `MediumDash`, `LongDash`, and `DashDot`.
 - Renamed the generic `Dashed` line style to `SpacedDash` to describe its visible spacing and distinguish it from the length-based dash presets.
-- Replaced public floating-point pixel sizes with integer styling values that GuideKit converts internally.
+- Replaced public floating-point pixel sizes with integer styling values that GuideKit Compose converts internally.
 - Replaced the separate single-phrase `descriptionHighlight` option with the unified `descriptionHighlights` list.
 - Changed `arrowHeadAngleDegrees` from a public `Float` to an `Int`, with conversion handled internally.
 
 ## [0.1.0] - 2026-07-16
 
 ### Added
 
-- Initial Compose Multiplatform GuideKit library.
+- Initial GuideKit Compose library for Compose Multiplatform.
 - Coachmark overlay with target highlights, instruction cards, arrows, step indicators, skip/finish callbacks, and auto-scroll support.
 - Rounded rectangle and circular target highlight styles.
 - Per-step style overrides for arrows, target highlights, instruction cards, and auto-scroll behavior.

README.md

@@ -1,7 +1,9 @@
 <p align="center">
-  <img src="docs/assets/guide_kit_logo_horizontal.png" alt="GuideKit" width="420" />
+  <img src="docs/assets/logo_fav.png" alt="GuideKit Compose mark" width="92" />
 </p>
 
+<h1 align="center">GuideKit Compose</h1>
+
 <p align="center">
   <strong>Beautiful coach marks for Compose Multiplatform</strong>
 </p>
@@ -11,7 +13,7 @@
 </p>
 
 <p align="center">
-  <a href="https://central.sonatype.com/search?q=guidekit"><img alt="Maven Central" src="https://img.shields.io/badge/Maven%20Central-1.1.0-1f6feb?style=for-the-badge" /></a>
+  <a href="https://central.sonatype.com/search?q=guidekit"><img alt="Maven Central" src="https://img.shields.io/badge/Maven%20Central-1.2.0-1f6feb?style=for-the-badge" /></a>
   <img alt="Android" src="https://img.shields.io/badge/Android-supported-16A34A?style=for-the-badge&logo=android&logoColor=white" />
   <img alt="iOS" src="https://img.shields.io/badge/iOS-supported-2563EB?style=for-the-badge&logo=apple&logoColor=white" />
   <img alt="Kotlin Multiplatform" src="https://img.shields.io/badge/Kotlin%20Multiplatform-ready-7F52FF?style=for-the-badge&logo=kotlin&logoColor=white" />
@@ -28,27 +30,27 @@
 </p>
 
 <p align="center">
-  <img src="docs/assets/guide_kit_banner.png" alt="GuideKit banner" width="100%" />
+  <img src="docs/assets/guide_kit_banner.png" alt="GuideKit Compose banner" width="100%" />
 </p>
 
 ---
 
 ## Live Demo
 
 <p align="center">
-  <img src="docs/assets/demo_3_1.gif" alt="GuideKit demo showing coach marks, arrows, and auto-scroll" width="320" />
+  <img src="docs/assets/demo_3_1.gif" alt="GuideKit Compose demo showing coach marks, arrows, and auto-scroll" width="320" />
   &nbsp;&nbsp;&nbsp;
-  <img src="docs/assets/demo_3_2.gif" alt="GuideKit demo showing alternate styling and circular highlights" width="320" />
+  <img src="docs/assets/demo_3_2.gif" alt="GuideKit Compose demo showing alternate styling and circular highlights" width="320" />
 </p>
 
 ---
 
 ## Installation
 
-Add GuideKit to the Compose Multiplatform source set where you want to show tours.
+Add GuideKit Compose to the Compose Multiplatform source set where you want to show tours.
 
 ```kotlin
-implementation("io.github.tharukack:guidekit:1.1.0")
+implementation("io.github.tharukack:guidekit:1.2.0")
 ```
 
 For Kotlin Multiplatform projects:
@@ -57,11 +59,25 @@ For Kotlin Multiplatform projects:
 kotlin {
     sourceSets {
         commonMain.dependencies {
-            implementation("io.github.tharukack:guidekit:1.1.0")
+            implementation("io.github.tharukack:guidekit:1.2.0")
         }
     }
 }
 ```
+
+### Requirements / compatibility
+
+GuideKit Compose `1.2.0` is published with the following platform and dependency requirements:
+
+| Requirement | Compatibility |
+| --- | --- |
+| Kotlin | `2.3.0` |
+| Compose Multiplatform | `1.11.1` |
+| Material 3 | `1.10.0-alpha05` |
+| Android | `minSdk 23` or newer |
+| iOS device | ARM64 (`iosArm64`) |
+| iOS simulator | Apple Silicon ARM64 (`iosSimulatorArm64`) |
+
 ---
 
 ## Quick Start
@@ -159,7 +175,7 @@ See the [`sample`](sample/) app for full configuration, styling, auto-scroll, ar
 
 ### Add multiple steps
 
-Add one `GuideKitStep` for each composable you want to highlight. Every step receives the bounds measured from its own target composable, and the order of the list determines the order of the tour. GuideKit automatically handles next, previous, and finish navigation.
+Add one `GuideKitStep` for each composable you want to highlight. Every step receives the bounds measured from its own target composable, and the order of the list determines the order of the tour. GuideKit Compose automatically handles next, previous, and finish navigation.
 
 The following example creates a three-step guide. `createButtonBounds`, `activityCardBounds`, and `profileButtonBounds` are measured and sent to the parent using the same callback pattern shown in the Quick Start.
 
@@ -286,7 +302,7 @@ All ordinary override properties default to `null`, meaning “inherit the globa
 
 ### Customize step text
 
-Each step requires a title and description. You can highlight one or more exact phrases and change the primary button label. When `primaryButtonText` is not provided, GuideKit uses **Next** and changes the final step to **Got it**.
+Each step requires a title and description. You can highlight one or more exact phrases and change the primary button label. When `primaryButtonText` is not provided, GuideKit Compose uses **Next** and changes the final step to **Got it**.
 
 ```kotlin
 GuideKitStep(
@@ -361,7 +377,7 @@ val specialStep = GuideKitStep(
 )
 ```
 
-GuideKit translates the selected `lineStyle` into its internal drawing pattern, so applications do not need to manage raw dash lengths or gaps.
+GuideKit Compose translates the selected `lineStyle` into its internal drawing pattern, so applications do not need to manage raw dash lengths or gaps.
 
 | Arrow option | Default | Purpose |
 | --- | --- | --- |
@@ -527,7 +543,7 @@ The same pattern is available for nullable values such as `outerPadding`, size c
 
 ### Configure automatic scrolling
 
-Auto-scroll is enabled for each step by default, but the host screen must provide `onScrollBy`. GuideKit calculates the required distance and delegates the actual scroll operation to your scroll state.
+Auto-scroll is enabled for each step by default, but the host screen must provide `onScrollBy`. GuideKit Compose calculates the required distance and delegates the actual scroll operation to your scroll state.
 
 ```kotlin
 val scrollState = rememberScrollState()
@@ -547,7 +563,7 @@ Tune or disable scrolling for an individual step:
 GuideKitStep(
     targetBounds = lowerCardBounds,
     title = "More options below",
-    description = "GuideKit scrolls this target into a safe position.",
+    description = "GuideKit Compose scrolls this target into a safe position.",
     autoScroll = GuideKitAutoScrollConfig(
         enabled = true,
         minTopVisibleDistance = 56.dp,
@@ -566,7 +582,7 @@ Use `GuideKitAutoScrollConfig(enabled = false)` for fixed targets such as a floa
 
 ### Configure navigation and callbacks
 
-GuideKit owns the current step and its next, previous, skip, and finish behavior. The host app can choose the starting step, show or hide progress, observe changes, and persist completion.
+GuideKit Compose owns the current step and its next, previous, skip, and finish behavior. The host app can choose the starting step, show or hide progress, observe changes, and persist completion.
 
 ```kotlin
 GuideKit(
@@ -606,7 +622,7 @@ GuideKit(
 | `onSkipped` | `null` | Shows the close button and runs when the user skips. `null` removes skip. |
 | `onFinished` | Required | Runs when the primary button is pressed on the final step. |
 
-Users can move back to the previous step by swiping the instruction card to the right. GuideKit consumes touches while the overlay is visible so the underlying screen is not activated accidentally.
+Users can move back to the previous step by swiping the instruction card to the right. GuideKit Compose consumes touches while the overlay is visible so the underlying screen is not activated accidentally.
 
 ---
 
@@ -621,7 +637,7 @@ Users can move back to the previous step by swiping the instruction card to the
 | Instruction cards | Show titles, descriptions, highlighted text, buttons, and progress. |
 | Auto-scroll | Automatically scroll to keep targets visible and clear of the card. |
 | Per-step customization | Override arrows, highlights, cards, labels, and scrolling per step. |
-| Internal step management | GuideKit owns next, previous, skip, finish, and current step state. |
+| Internal step management | GuideKit Compose owns next, previous, skip, finish, and current step state. |
 | Callbacks | React to step changes, skipped tours, and completed tours. |
 | Compose Multiplatform | Shared Kotlin API for Android and iOS Compose apps. |
 
@@ -655,7 +671,7 @@ Users can move back to the previous step by swiping the instruction card to the
 
 ## Contributing
 
-Contributions are welcome. If you want to improve GuideKit, start with a small issue, bug report, or sample enhancement.
+Contributions are welcome. If you want to improve GuideKit Compose, start with a small issue, bug report, or sample enhancement.
 
 Before opening a pull request:
 
@@ -671,5 +687,5 @@ Before opening a pull request:
 MIT License. See [`LICENSE`](LICENSE).
 
 <p align="center">
-  <strong>GuideKit</strong> is built for developers who want onboarding to feel native, polished, and easy to maintain.
+  <strong>GuideKit Compose</strong> is built for developers who want onboarding to feel native, polished, and easy to maintain.
 </p>

build.gradle.kts

@@ -9,7 +9,7 @@ plugins {
 }
 
 group = "io.github.tharukack"
-version = "1.1.0"
+version = "1.2.0"
 
 kotlin {
     androidTarget {
@@ -35,7 +35,6 @@ kotlin {
             api(libs.compose.foundation)
             implementation(libs.compose.material3)
             implementation(libs.compose.material.icons.core)
-            implementation(libs.compose.material.icons.extended)
         }
         commonTest.dependencies {
             implementation(libs.kotlin.test)
@@ -68,7 +67,7 @@ mavenPublishing {
     )
 
     pom {
-        name.set("GuideKit")
+        name.set("GuideKit Compose")
         description.set(
             "A Compose Multiplatform coachmark overlay library for " +
                     "product tours, onboarding hints, and guided feature discovery."