Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
msfjarvis committed Oct 19, 2023
1 parent 8bf74ec commit 00bb77f
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
# 🚧 kage 🚧
# 🚧 kage 🚧 ![Maven Central](https://img.shields.io/maven-central/v/com.github.android-password-store/kage?style=flat-square&label=Latest%20version)

<p align="center"><img alt="The age logo, an wireframe of St. Peters dome in Rome, with the text: age, file encryption" width="600" src="https://user-images.githubusercontent.com/1225294/132245842-fda4da6a-1cea-4738-a3da-2dc860861c98.png"></p>

kage is a work-in-progress implementation of the [age encryption protocol] for Kotlin/JVM and Android. The [reference Go implementation] and the third-party [Rust implementation] are being used as reference for the development of the library.

## Download

The library does not have a stable release yet but you can obtain snapshots from [Sonatype's snapshots repository].
An initial alpha release is available on [Maven Central]

```kotlin
// build.gradle.kts
dependencies {
implementation("com.github.android-password-store:kage:0.1.0")
}
```

Builds from the development branch can be obtained from [Sonatype's snapshots repository].

```kotlin
// settings.gradle.kts
Expand All @@ -24,7 +33,7 @@ dependencyResolutionManagement {
```kotlin
// build.gradle.kts
dependencies {
implementation("com.github.android-password-store:kage:0.0.1-SNAPSHOT")
implementation("com.github.android-password-store:kage:0.2.0-SNAPSHOT")
}
```

Expand Down Expand Up @@ -63,3 +72,4 @@ conditions.
[reference go implementation]: https://github.com/FiloSottile/age
[rust implementation]: https://github.com/str4d/rage
[sonatype's snapshots repository]: https://oss.sonatype.org/content/repositories/snapshots
[maven central]: https://central.sonatype.com/

0 comments on commit 00bb77f

Please sign in to comment.