summaryrefslogtreecommitdiff
path: root/openpgp-ktx/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'openpgp-ktx/README.md')
-rw-r--r--openpgp-ktx/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/openpgp-ktx/README.md b/openpgp-ktx/README.md
new file mode 100644
index 00000000..2ee2ef00
--- /dev/null
+++ b/openpgp-ktx/README.md
@@ -0,0 +1,14 @@
+# openpgp-ktx [![Download](https://api.bintray.com/packages/android-password-store/openpgp-ktx/openpgp-ktx/images/download.svg)](https://bintray.com/android-password-store/openpgp-ktx/openpgp-ktx/_latestVersion)
+
+Reimplementation of [OpenKeychain]'s integration library [openpgp-api]. Written entirely in Kotlin, it leverages Jetpack to be compatible with modern apps, unlike the original library.
+
+## Using this with your projects
+
+```gradle
+dependencies {
+ implementation("com.github.androidpasswordstore:openpgp-ktx:<latest-version>")
+}
+```
+
+[OpenKeychain]: https://github.com/open-keychain/open-keychain
+[openpgp-api]: https://github.com/open-keychain/openpgp-api