Skip to content

Commit

Permalink
Prepare 0.2.2 release
Browse files Browse the repository at this point in the history
  • Loading branch information
05nelsonm committed Apr 7, 2023
1 parent ab02d6e commit 779f462
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 14 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# CHANGELOG

## Version 0.2.2 (2023-04-07)
- Adds `SHA3`
- Updates `kotlincrypto.core` to `0.2.2`

## Version 0.2.1 (2023-03-28)
- Updates `kotlincrypto.core` to `0.2.0`
- Updates the `Digest.compress` function with API change
Expand Down
28 changes: 15 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

[![badge-kotlin]][url-kotlin]
[![badge-core]][url-core]
[![badge-endians]][url-endians]
[![badge-sponges]][url-sponges]

![badge-platform-android]
![badge-platform-jvm]
Expand Down Expand Up @@ -72,7 +74,6 @@ fun main() {
}
```

<!-- TODO: Uncomment
`SHA-3` `Digest`s

```kotlin
Expand Down Expand Up @@ -134,28 +135,19 @@ fun main() {
}
```

-->

### Get Started

The best way to keep `KotlinCrypto` dependencies up to date is by using the
[version-catalog][url-version-catalog]. Alternatively, you can use the BOM as
shown below.

<!-- TAG_VERSION -->
<!-- TODO: Add
// Keccak-224, Keccak-256, Keccak-384, Keccak-512
// SHA3-224, SHA3-256, SHA3-384, SHA3-512
// SHAKE128, SHAKE256
// CSHAKE128, CSHAKE256
implementation("org.kotlincrypto.hash:sha3")
-->

```kotlin
// build.gradle.kts
dependencies {
// define the BOM and its version
implementation(platform("org.kotlincrypto.hash:bom:0.2.1"))
implementation(platform("org.kotlincrypto.hash:bom:0.2.2"))

// define artifacts without version

Expand All @@ -167,16 +159,24 @@ dependencies {

// SHA-224, SHA-256, SHA-384, SHA-512, SHA-512/224, SHA-512/256
implementation("org.kotlincrypto.hash:sha2")

// Keccak-224, Keccak-256, Keccak-384, Keccak-512
// SHA3-224, SHA3-256, SHA3-384, SHA3-512
// SHAKE128, SHAKE256
// CSHAKE128, CSHAKE256
implementation("org.kotlincrypto.hash:sha3")
}
```

<!-- TAG_VERSION -->
[badge-latest-release]: https://img.shields.io/badge/latest--release-0.2.1-blue.svg?style=flat
[badge-latest-release]: https://img.shields.io/badge/latest--release-0.2.2-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.0-blue.svg
[badge-core]: https://img.shields.io/badge/kotlincrypto.core-0.2.2-blue.svg
[badge-endians]: https://img.shields.io/badge/kotlincrypto.endians-0.1.0-blue.svg
[badge-sponges]: https://img.shields.io/badge/kotlincrypto.sponges-0.1.0-blue.svg

<!-- TAG_PLATFORMS -->
[badge-platform-android]: http://img.shields.io/badge/-android-6EDB8D.svg?style=flat
Expand All @@ -200,6 +200,8 @@ dependencies {
[url-license]: https://www.apache.org/licenses/LICENSE-2.0.txt
[url-kotlin]: https://kotlinlang.org
[url-core]: https://github.com/KotlinCrypto/core
[url-endians]: https://github.com/KotlinCrypto/endians
[url-sponges]: https://github.com/KotlinCrypto/sponges
[url-encoding]: https://github.com/05nelsonm/encoding
[url-macs]: https://github.com/KotlinCrypto/MACs
[url-version-catalog]: https://github.com/KotlinCrypto/version-catalog
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ POM_DEVELOPER_ID=KotlinCrypto
POM_DEVELOPER_NAME=Kotlin Crypto
POM_DEVELOPER_URL=https://github.com/KotlinCrypto/

VERSION_NAME=0.2.2-SNAPSHOT
VERSION_NAME=0.2.2
# 0.1.0-alpha01 = 00 01 00 11
# 0.1.0-beta01 = 00 01 00 21
# 0.1.0-rc01 = 00 01 00 31
Expand Down

0 comments on commit 779f462

Please sign in to comment.