Prepare 0.2.4 release

Author: 05nelsonm

CHANGELOG.md

@@ -1,15 +1,22 @@
 # CHANGELOG
 
-## Version 0.2.3 (2023-07-08)
+## Version 0.2.4 (2023-04-16)
+ - Updates `kotlincrypto.core` to `0.2.4`
+ - Updates `kotlincrypto.hash` to `0.2.4`
+ - Adds a new module `kmac` [[#26]][26]
+     - Adds `KMAC128`
+     - Adds `KMAC256`
+
+## Version 0.2.3 (2023-04-08)
  - Adds a new module, `hmac-sha3` [[#21]][21]
-     - `HmacKeccak224`
-     - `HmacKeccak256`
-     - `HmacKeccak384`
-     - `HmacKeccak512`
-     - `HmacSHA3_224`
-     - `HmacSHA3_256`
-     - `HmacSHA3_384`
-     - `HmacSHA3_512`
+     - Adds `HmacKeccak224`
+     - Adds `HmacKeccak256`
+     - Adds `HmacKeccak384`
+     - Adds `HmacKeccak512`
+     - Adds `HmacSHA3-224`
+     - Adds `HmacSHA3-256`
+     - Adds `HmacSHA3-384`
+     - Adds `HmacSHA3-512`
  - Cleans up `Hmac` implementation [[#21]][21]
  - Updates `kotlincrypto.core` to `0.2.3` [[#23]][23]
  - Updates `kotlincrypto.hash` to `0.2.3` [[#23]][23]
@@ -19,9 +26,9 @@
  - Updates `kotlincrypto.hash` to `0.2.1`
 
 ## Version 0.2.0 (2023-03-12)
- - Adds `HmacSHA224` algorithm
- - Adds `HmacSHA384` algorithm
- - Adds `HmacSHA512t` algorithm
+ - Adds `HmacSHA224`
+ - Adds `HmacSHA384`
+ - Adds `HmacSHA512t`
  - Combines all `hmac-sha2-*` algorithms into single `hmac-sha2` module
 
 ## Version 0.1.0 (2023-03-06)
@@ -36,3 +43,4 @@
 
 [21]: https://github.com/KotlinCrypto/MACs/pull/21
 [23]: https://github.com/KotlinCrypto/MACs/pull/23
+[26]: https://github.com/KotlinCrypto/MACs/pull/26

README.md

@@ -84,26 +84,27 @@ fun main() {
 }
 ```
 
-<!-- TODO: Uncomment
 `SHA3 KMAC & XOFs` (i.e. [Extendable-Output Functions][url-pub-xof])
 
 See [HERE][url-core-usage] for details on what `XOFs` are, and a basic usage example for `Xof`.
 
 ```kotlin
 fun main() {
     val key = SecureRandom().nextBytesOf(100)
-    
-    KMAC128(key)     // as a Mac
-    KMAC128.xOf(key) // as a Xof (Extendable-Output Function)
 
     val S = "My Customization".encodeToByteArray()
-    KMAC256(key, S, outputLength = 123)
+
+    // Macs
+    KMAC128(key)
+    KMAC256(key, S, outputLength = 123) // returns 123 bytes instead of the default when doFinal() is invoked
+    
+    // Xofs
+    KMAC128.xOf(key, S)
     KMAC256.xOf(key)
 
     key.fill(0)
 }
 ```
--->
 
 ### Get Started
 
@@ -113,16 +114,11 @@ shown below.
 
 <!-- TAG_VERSION -->
 
-<!-- TODO: Add to dependencies
-    // KMAC128, KMAC256
-    implementation("org.kotlincrypto.macs:kmac")
--->
-
 ```kotlin
 // build.gradle.kts
 dependencies {
     // define the BOM and its version
-    implementation(platform("org.kotlincrypto.macs:bom:0.2.3"))
+    implementation(platform("org.kotlincrypto.macs:bom:0.2.4"))
 
     // define artifacts without version
 
@@ -138,17 +134,20 @@ dependencies {
     // HmacKeccak224, HmacKeccak256, HmacKeccak384, HmacKeccak512
     // HmacSHA3-224, HmacSHA3-256, HmacSHA3-384, HmacSHA3-512
     implementation("org.kotlincrypto.macs:hmac-sha3")
+
+    // KMAC128, KMAC256
+    implementation("org.kotlincrypto.macs:kmac")
 }
 ```
 
 <!-- TAG_VERSION -->
-[badge-latest-release]: https://img.shields.io/badge/latest--release-0.2.3-blue.svg?style=flat
+[badge-latest-release]: https://img.shields.io/badge/latest--release-0.2.4-blue.svg?style=flat
 [badge-license]: https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat
 
 <!-- TAG_DEPENDENCIES -->
 [badge-kotlin]: https://img.shields.io/badge/kotlin-1.8.10-blue.svg?logo=kotlin
-[badge-core]: https://img.shields.io/badge/kotlincrypto.core-0.2.3-blue.svg
-[badge-hash]: https://img.shields.io/badge/kotlincrypto.hash-0.2.3-blue.svg
+[badge-core]: https://img.shields.io/badge/kotlincrypto.core-0.2.4-blue.svg
+[badge-hash]: https://img.shields.io/badge/kotlincrypto.hash-0.2.4-blue.svg
 
 <!-- TAG_PLATFORMS -->
 [badge-platform-android]: http://img.shields.io/badge/-android-6EDB8D.svg?style=flat

gradle.properties

@@ -29,7 +29,7 @@ POM_DEVELOPER_ID=KotlinCrypto
 POM_DEVELOPER_NAME=Kotlin Crypto
 POM_DEVELOPER_URL=https://github.com/KotlinCrypto/
 
-VERSION_NAME=0.2.4-SNAPSHOT
+VERSION_NAME=0.2.4
 # 0.1.0-alpha01 = 00 01 00 11
 # 0.1.0-beta01  = 00 01 00 21
 # 0.1.0-rc01    = 00 01 00 31

gradle/libs.versions.toml

@@ -2,8 +2,8 @@
 binaryCompat = "0.13.0"
 bouncyCastle = "1.72"
 configuration = "0.1.0-beta02"
-cryptoCore = "0.2.4-SNAPSHOT"
-cryptoHash = "0.2.4-SNAPSHOT"
+cryptoCore = "0.2.4"
+cryptoHash = "0.2.4"
 encoding = "1.2.1"
 gradleVersions = "0.46.0"
 kotlin = "1.8.10"