From f24b817bad4cf49a76c3bffab7f24fa4f0e11410 Mon Sep 17 00:00:00 2001 From: Ugljesa Jovanovic Date: Sat, 13 Jun 2020 16:31:14 +0200 Subject: [PATCH 1/2] Update readme --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d3ef323..497e3fc 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,9 @@ APIs of both variants are identical. |minGW X86 64| :heavy_check_mark: | :heavy_check_mark: | |minGW X86 32| :x: | :x: | - +## Sample project +The library includes sample project that shows usage on different platforms +- NOTE: Currently only linux, macOs and windows are included. ## Notes & Roadmap @@ -40,6 +42,8 @@ APIs of both variants are identical. Next steps: - Expand API (AEAD, ECC ...) +- Include AES and Argon2 in new API approach +- Add primitives missing in `delegated` variant that are supported in `pure` (at the moment AES and Argon2) ## Should I use this in production? @@ -88,14 +92,17 @@ The following table describes which library is used for particular cryptographic ## Integration +NOTE: Latest version of the library is built with Kotlin 1.4-M2 and therefore only SNAPSHOT variant is available. Next +stable version will be released when Kotlin 1.4. is released + #### Gradle Kotlin ```kotlin -implementation("com.ionspin.kotlin:multiplatform-crypto:0.0.5") +implementation("com.ionspin.kotlin:multiplatform-crypto:0.1.0") or -implementation("com.ionspin.kotlin:multiplatform-crypto-delegated:0.0.5") +implementation("com.ionspin.kotlin:multiplatform-crypto-delegated:0.1.0") ``` #### Snapshot builds @@ -105,7 +112,7 @@ repositories { url = uri("https://oss.sonatype.org/content/repositories/snapshots") } } -implementation("com.ionspin.kotlin:multiplatform-crypto:0.0.6-SNAPSHOT") +implementation("com.ionspin.kotlin:multiplatform-crypto:0.1.0-SNAPSHOT") ``` From a3cb4f653a2030bf6a5b0eb89c70acaf44c27412 Mon Sep 17 00:00:00 2001 From: Ugljesa Jovanovic Date: Sat, 13 Jun 2020 18:16:07 +0200 Subject: [PATCH 2/2] Use dev version of dokka because we are in 1.4-M2 --- build.gradle.kts | 4 +++- buildSrc/build.gradle.kts | 1 + buildSrc/src/main/kotlin/Deps.kt | 2 +- multiplatform-crypto-api/build.gradle.kts | 13 ++----------- multiplatform-crypto-delegated/build.gradle.kts | 3 ++- multiplatform-crypto/build.gradle.kts | 12 +----------- sample/build.gradle.kts | 7 ------- settings.gradle.kts | 1 + 8 files changed, 11 insertions(+), 32 deletions(-) diff --git a/build.gradle.kts b/build.gradle.kts index 7d473f6..7a49d0a 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -23,6 +23,7 @@ buildscript { google() maven ("https://kotlin.bintray.com/kotlinx") maven ("https://dl.bintray.com/kotlin/kotlin-eap") + maven ("https://dl.bintray.com/kotlin/kotlin-dev") gradlePluginPortal() jcenter() } @@ -30,6 +31,7 @@ buildscript { dependencies { classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:${Versions.kotlin}") classpath ("gradle.plugin.org.jlleitschuh.gradle:ktlint-gradle:5.0.0") + classpath ("org.jetbrains.dokka:dokka-gradle-plugin:${Versions.dokkaPlugin}") } } @@ -40,7 +42,7 @@ allprojects { google() maven ("https://kotlin.bintray.com/kotlinx") maven ("https://dl.bintray.com/kotlin/kotlin-eap") - maven ("https://kotlin.bintray.com/kotlin-dev") + maven ("https://dl.bintray.com/kotlin/kotlin-dev") jcenter() maven { url = uri("https://oss.sonatype.org/content/repositories/snapshots") diff --git a/buildSrc/build.gradle.kts b/buildSrc/build.gradle.kts index 35e8766..1ed63da 100644 --- a/buildSrc/build.gradle.kts +++ b/buildSrc/build.gradle.kts @@ -23,6 +23,7 @@ plugins { repositories { mavenCentral() maven ("https://dl.bintray.com/kotlin/kotlin-eap") + maven("https://dl.bintray.com/kotlin/kotlin-dev") jcenter() } diff --git a/buildSrc/src/main/kotlin/Deps.kt b/buildSrc/src/main/kotlin/Deps.kt index 550f95b..1c80a48 100644 --- a/buildSrc/src/main/kotlin/Deps.kt +++ b/buildSrc/src/main/kotlin/Deps.kt @@ -20,7 +20,7 @@ object Versions { val kotlinSerialization = "0.20.0-1.4-M2" val atomicfu = "0.14.3-M2-2-SNAPSHOT" //NOTE: my linux arm32 and arm64 build val nodePlugin = "1.3.0" - val dokkaPlugin = "0.9.18" + val dokkaPlugin = "0.11.0-dev-44" val taskTreePlugin = "1.5" val kotlinBigNumVersion = "0.1.6-1.4-M2-SNAPSHOT" diff --git a/multiplatform-crypto-api/build.gradle.kts b/multiplatform-crypto-api/build.gradle.kts index a689963..4ec7aba 100644 --- a/multiplatform-crypto-api/build.gradle.kts +++ b/multiplatform-crypto-api/build.gradle.kts @@ -24,7 +24,7 @@ plugins { kotlin(PluginsDeps.multiplatform) id (PluginsDeps.mavenPublish) id (PluginsDeps.signing) - id (PluginsDeps.dokka) version Versions.dokkaPlugin + id (PluginsDeps.dokka) } repositories { @@ -275,16 +275,7 @@ tasks { } dokka { - println ("Dokka !") - impliedPlatforms = mutableListOf("Common") - kotlinTasks { - listOf() - } - sourceRoot { - println ("Common !") - path = "/home/ionspin/Projects/Future/kotlin-multiplatform-crypto/crypto/src/commonMain" //TODO remove static path! - platforms = listOf("Common") - } + println("Dokka !") } if (getHostOsName() == "linux" && getHostArchitecture() == "x86-64") { diff --git a/multiplatform-crypto-delegated/build.gradle.kts b/multiplatform-crypto-delegated/build.gradle.kts index e4cac24..ddfc8a8 100644 --- a/multiplatform-crypto-delegated/build.gradle.kts +++ b/multiplatform-crypto-delegated/build.gradle.kts @@ -26,7 +26,7 @@ plugins { id(PluginsDeps.mavenPublish) id(PluginsDeps.signing) id(PluginsDeps.node) version Versions.nodePlugin - id(PluginsDeps.dokka) version Versions.dokkaPlugin + id(PluginsDeps.dokka) id(PluginsDeps.taskTree) version Versions.taskTreePlugin } @@ -542,6 +542,7 @@ tasks { } dokka { + println("Dokka !") } if (getHostOsName() == "linux" && getHostArchitecture() == "x86-64") { val jvmTest by getting(Test::class) { diff --git a/multiplatform-crypto/build.gradle.kts b/multiplatform-crypto/build.gradle.kts index cd14d94..81084a3 100644 --- a/multiplatform-crypto/build.gradle.kts +++ b/multiplatform-crypto/build.gradle.kts @@ -24,7 +24,7 @@ plugins { id(PluginsDeps.mavenPublish) id(PluginsDeps.signing) id(PluginsDeps.node) version Versions.nodePlugin - id(PluginsDeps.dokka) version Versions.dokkaPlugin + id(PluginsDeps.dokka) } val sonatypeStaging = "https://oss.sonatype.org/service/local/staging/deploy/maven2/" @@ -369,16 +369,6 @@ tasks { dokka { println("Dokka !") - impliedPlatforms = mutableListOf("Common") - kotlinTasks { - listOf() - } - sourceRoot { - println("Common !") - path = - "/home/ionspin/Projects/Future/kotlin-multiplatform-crypto/crypto/src/commonMain" //TODO remove static path! - platforms = listOf("Common") - } } if (getHostOsName() == "linux" && getHostArchitecture() == "x86-64") { diff --git a/sample/build.gradle.kts b/sample/build.gradle.kts index 06a23de..96cfab1 100644 --- a/sample/build.gradle.kts +++ b/sample/build.gradle.kts @@ -25,7 +25,6 @@ plugins { id (PluginsDeps.mavenPublish) id (PluginsDeps.signing) id (PluginsDeps.node) version Versions.nodePlugin - id (PluginsDeps.dokka) version Versions.dokkaPlugin } val sonatypeStaging = "https://oss.sonatype.org/service/local/staging/deploy/maven2/" @@ -279,12 +278,6 @@ kotlin { tasks { - create("javadocJar") { - dependsOn(dokka) - archiveClassifier.set("javadoc") - from(dokka.get().outputDirectory) - } - if (getHostOsName() == "linux") { diff --git a/settings.gradle.kts b/settings.gradle.kts index fa503b5..92e8084 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -18,6 +18,7 @@ pluginManagement { repositories { maven("https://dl.bintray.com/kotlin/kotlin-eap") + maven("https://dl.bintray.com/kotlin/kotlin-dev") mavenCentral()