Version 1.1.0 (#12)

deepmedia · Aug 25, 2024 · f20d9e0 · f20d9e0
1 parent fdf3baf
commit f20d9e0
Show file tree

Hide file tree

Showing 25 changed files with 48 additions and 13 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -1,5 +1,4 @@
 # https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions
-# Renaming ? Change the README badge.
 name: Build
 on:
   push:
@@ -17,6 +16,7 @@ jobs:
           java-version: 17
           distribution: temurin
           cache: gradle
+      - uses: gradle/actions/wrapper-validation@v4
       - name: Check local deployment
         run: ./gradlew build deployLocal
   CHECK_TESTS:

diff --git a/.github/workflows/snapshot.yml b/.github/workflows/snapshot.yml
@@ -1,5 +1,4 @@
 # https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions
-# Renaming ? Change the README badge.
 name: Snapshot
 on:
   push:

diff --git a/.idea/kotlinc.xml b/.idea/kotlinc.xml
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 [![Build Status](https://github.com/deepmedia/Knee/actions/workflows/build.yml/badge.svg?event=push)](https://github.com/deepmedia/Knee/actions)
 [![Release](https://img.shields.io/github/release/deepmedia/Knee.svg)](https://github.com/deepmedia/Knee/releases)
-[![Issues](https://img.shields.io/github/issues-raw/deepmedia/MavenDeployer.svg)](https://github.com/deepmedia/Knee/issues)
+[![Issues](https://img.shields.io/github/issues-raw/deepmedia/Knee.svg)](https://github.com/deepmedia/Knee/issues)
 
 ![Project logo](assets/logo_256.png)
 
@@ -23,7 +23,7 @@ pluginManagement {
 
 // build.gradle.kts
 plugins {
-    id("io.deepmedia.tools.knee") version "1.0.0"
+    id("io.deepmedia.tools.knee") version "1.1.0"
 }
 ```
 

diff --git a/docs/concepts.mdx b/docs/concepts.mdx
@@ -1,5 +1,6 @@
 ---
 title: Concepts
+description: Discover Knee's main concepts - the motivation behind the plugin and notes about its architecture and design.
 ---
 
 # Concepts

diff --git a/docs/configure.mdx b/docs/configure.mdx
@@ -1,5 +1,8 @@
 ---
 title: Configure
+description: >
+  Check out all available options to configure Knee Gradle Plugin, like verbosity, output directories and automatic
+  target connection in Kotlin Multiplatform projects.
 ---
 
 # Configuration

diff --git a/docs/features/builtin-types.mdx b/docs/features/builtin-types.mdx
@@ -1,5 +1,8 @@
 ---
 title: Built-in types
+description: >
+  Understand how Knee compiler plugin can serialize several built-in types from the Kotlin standard library and let
+  you pass them from Kotlin Native to the JVM and vice versa.
 ---
 
 # Built-in types

diff --git a/docs/features/callables.mdx b/docs/features/callables.mdx
@@ -1,5 +1,8 @@
 ---
 title: Callables
+description: >
+  Learn about the concept of callables in Knee - a set of function and properties that are explicitly marked
+  to be serializable and represent the links between the Native and JVM part of your Kotlin project.
 ---
 
 # Callables

diff --git a/docs/features/classes.mdx b/docs/features/classes.mdx
@@ -1,5 +1,8 @@
 ---
 title: Classes
+description: >
+  Understand how Knee compiler plugin can serialize declared classes and let you pass them from Kotlin Native
+  to the JVM and vice versa, including support for externally defined classes.
 ---
 
 # Classes

diff --git a/docs/features/enums.mdx b/docs/features/enums.mdx
@@ -1,5 +1,8 @@
 ---
 title: Enums
+description: >
+  Understand how Knee compiler plugin can serialize Kotlin enumerations and let you pass them from Kotlin Native
+  to the JVM and vice versa, including support for externally defined enums.
 ---
 
 # Enums

diff --git a/docs/features/exceptions.mdx b/docs/features/exceptions.mdx
@@ -1,5 +1,8 @@
 ---
 title: Exceptions
+description: >
+  Learn about how the Knee compiler plugin deals with exceptions across the Kotlin Native / JVM boundary and how you
+  can define custom, serializable exceptions.
 ---
 
 # Exceptions

diff --git a/docs/features/index.mdx b/docs/features/index.mdx
@@ -1,5 +1,8 @@
 ---
 title: Features
+description: >
+  Discover our comprehensive guide across all Knee compiler plugin features to enable communication between Kotlin Native
+  and Kotlin JVM in your project.
 docs:
   - callables
   - suspend-functions

diff --git a/docs/features/interfaces.mdx b/docs/features/interfaces.mdx
@@ -1,5 +1,8 @@
 ---
 title: Interfaces
+description: >
+  Understand how Knee compiler plugin can serialize declared interfaces and let you pass them from Kotlin Native
+  to the JVM and vice versa, including support for externally defined interfaces.
 ---
 
 # Interfaces

diff --git a/docs/features/suspend-functions.mdx b/docs/features/suspend-functions.mdx
@@ -1,5 +1,8 @@
 ---
 title: Suspend functions
+description: >
+  Understand how Knee can provide structured concurrency across the JNI boundary thanks to Kotlin suspend functions,
+  from Kotlin Native to JVM and vice versa.
 ---
 
 # Suspend Functions

diff --git a/docs/index.mdx b/docs/index.mdx
@@ -1,5 +1,8 @@
 ---
 title: Intro
+description: >
+  Knee provides seamless two-way communication between Kotlin/Native and Kotlin/JVM. Supports suspend functions, classes,
+  interfaces, no-copy buffers and much more.
 docs:
   - install
   - concepts

diff --git a/docs/initialize.mdx b/docs/initialize.mdx
@@ -1,5 +1,6 @@
 ---
 title: Initialize
+description: Understand all the possible options to initialize Knee at runtime and learn about the concept of KneeModules.
 ---
 
 # Initialization

diff --git a/docs/install.mdx b/docs/install.mdx
@@ -1,5 +1,6 @@
 ---
 title: Install
+description: Follow the instructions to download Knee Gradle Plugin and runtime and discover how to install release snapshots.
 ---
 
 # Installation
@@ -22,10 +23,12 @@ pluginManagement {
 
 // build.gradle.kts
 plugins {
-    id("io.deepmedia.tools.knee") version "1.0.0"
+    id("io.deepmedia.tools.knee") version "LATEST_VERSION"
 }
 ```
 
+Replace `LATEST_VERSION` with the desired version number, {version}.
+
 ## Snapshots
 
 We regularly push development snapshots of the library at `https://s01.oss.sonatype.org/content/repositories/snapshots/`

diff --git a/docs/utilities.mdx b/docs/utilities.mdx
@@ -1,5 +1,6 @@
 ---
 title: Utilities
+description: Discover Knee extra utilities that provide a Kotlin-friendly wrapper over JNI APIs at runtime.
 ---
 
 # Utilities

diff --git a/gradle.properties b/gradle.properties
@@ -10,5 +10,5 @@ kotlin.mpp.import.enableKgpDependencyResolution=true
 
 android.useAndroidX=true
 
-knee.version=1.0.0
+knee.version=1.1.0
 knee.group=io.deepmedia.tools.knee
diff --git a/tests/test-classes/build.gradle.kts b/tests/test-classes/build.gradle.kts
@@ -3,7 +3,7 @@
 plugins {
     kotlin("multiplatform") version "2.0.20"
     id("com.android.application") version "8.1.1"
-    id("io.deepmedia.tools.knee") version "1.0.0"
+    id("io.deepmedia.tools.knee") version "1.1.0"
 }
 
 configurations.configureEach {

diff --git a/tests/test-coroutines/build.gradle.kts b/tests/test-coroutines/build.gradle.kts
@@ -3,7 +3,7 @@
 plugins {
     kotlin("multiplatform") version "2.0.20"
     id("com.android.application") version "8.1.1"
-    id("io.deepmedia.tools.knee") version "1.0.0"
+    id("io.deepmedia.tools.knee") version "1.1.0"
 }
 
 configurations.configureEach {

diff --git a/tests/test-imports/build.gradle.kts b/tests/test-imports/build.gradle.kts
@@ -3,7 +3,7 @@
 plugins {
     kotlin("multiplatform") version "2.0.20"
     id("com.android.application") version "8.1.1"
-    id("io.deepmedia.tools.knee") version "1.0.0"
+    id("io.deepmedia.tools.knee") version "1.1.0"
 }
 
 configurations.configureEach {

diff --git a/tests/test-interfaces/build.gradle.kts b/tests/test-interfaces/build.gradle.kts
@@ -3,7 +3,7 @@
 plugins {
     kotlin("multiplatform") version "2.0.20"
     id("com.android.application") version "8.1.1"
-    id("io.deepmedia.tools.knee") version "1.0.0"
+    id("io.deepmedia.tools.knee") version "1.1.0"
 }
 
 configurations.configureEach {

diff --git a/tests/test-misc/build.gradle.kts b/tests/test-misc/build.gradle.kts
@@ -3,7 +3,7 @@
 plugins {
     kotlin("multiplatform") version "2.0.20"
     id("com.android.application") version "8.1.1"
-    id("io.deepmedia.tools.knee") version "1.0.0"
+    id("io.deepmedia.tools.knee") version "1.1.0"
 }
 
 configurations.configureEach {

diff --git a/tests/test-primitives/build.gradle.kts b/tests/test-primitives/build.gradle.kts
@@ -3,7 +3,7 @@
 plugins {
     kotlin("multiplatform") version "2.0.20"
     id("com.android.application") version "8.1.1"
-    id("io.deepmedia.tools.knee") version "1.0.0"
+    id("io.deepmedia.tools.knee") version "1.1.0"
 }
 
 configurations.configureEach {