diff --git a/README.md b/README.md index 1b5b6b69..5cb029cb 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,9 @@ familiar. ## Notes & Roadmap -This is very early version of the library, and has the base implementation of **integer** and **floating point** operations. -Modular arithmetic is planned for future releases, as well as improvements such as Karatsuba multiplication, -Toom-Cook, division using multiplication by reciprocal, and other. +This is an implementation of pure kotlin arbitrary integer and floating-point arithmetic support. -**The API will move fast and break often until v1.0** +**The APIs might change until v1.0** Also, there is a plan to implement platform native versions. @@ -21,26 +19,16 @@ Testing to verify that the library works properly is mostly done against Java Bi ## Should I use this in production? -The library is still under heavy development, and relies on experimental kotlin features, like unsigned integer. +The library is still under development, but at the moment it is feature complete, further improvements will be optimizations +and bug-fixing. ## Integration #### Gradle ```kotlin -implementation("com.ionspin.kotlin:bignum:0.2.0") +implementation("com.ionspin.kotlin:bignum:0.2.1") ``` -#### Gradle Metadata -BigNum library up to 0.1.0 was published with Gradle Metadata 0.4 -To use it you need to add -``` -enableFeaturePreview("GRADLE_METADATA") -``` -to your `settings.gradle` file - -From version 0.1.3 BigNum library will be publishing Gradle Metadata 1.0.0 which will only be usable by Gradle >= 5.3. -If you are using version 0.1.1 you don't need to modify your settings.gradle - #### Snapshot builds ```kotlin repositories { @@ -48,7 +36,7 @@ repositories { url = uri("https://oss.sonatype.org/content/repositories/snapshots") } } -implementation("com.ionspin.kotlin:bignum:0.2.1-SNAPSHOT ") +implementation("com.ionspin.kotlin:bignum:0.2.2-SNAPSHOT ") ``` diff --git a/bignum/build.gradle.kts b/bignum/build.gradle.kts index f43617c7..19b17e64 100644 --- a/bignum/build.gradle.kts +++ b/bignum/build.gradle.kts @@ -66,7 +66,7 @@ repositories { jcenter() } group = "com.ionspin.kotlin" -version = "0.2.1-SNAPSHOT" +version = "0.2.2-SNAPSHOT" val ideaActive = System.getProperty("idea.active") == "true" @@ -352,6 +352,12 @@ tasks { dokkaJavadoc { println("Dokka !") + dokkaSourceSets { + create("commonMain") { + displayName = "common" + platform = "common" + } + } } if (hostOsName == primaryDevelopmentOs) { val jvmTest by getting(Test::class) { diff --git a/buildSrc/src/main/kotlin/Deps.kt b/buildSrc/src/main/kotlin/Deps.kt index e9391081..2b79ec62 100644 --- a/buildSrc/src/main/kotlin/Deps.kt +++ b/buildSrc/src/main/kotlin/Deps.kt @@ -20,7 +20,7 @@ object Versions { val kotlin = "1.4.10" val kotlinSerialization = "1.0.0" val nodePlugin = "1.3.0" - val dokkaPlugin = "1.4.10" + val dokkaPlugin = "1.4.0-rc" } object Deps { diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index 3941ad8a..4f285781 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -16,6 +16,6 @@ # distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-6.3-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-6.6.1-bin.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists