Kevin Gorham
4 years ago
No known key found for this signature in database
GPG Key ID: CCA55602DF49FC38
3 changed files with
9 additions and
17 deletions
README.md
buildSrc/src/main/java/cash/z/ecc/android/Dependencies.kt
lib/build.gradle
@ -7,7 +7,9 @@
## Introduction
A concise implementation of [BIP-0039 ](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki ) in Kotlin for Android.
A concise implementation of [BIP-0039 ](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki ) in Kotlin for Android.
Only 30kB in total size. For comparison, the entire library is about 3X the size of this README file (because there are no dependencies)!
### Motivation
@ -24,11 +26,11 @@ Plus, it uses a permissive MIT license and no dependencies beyond Kotlin's stdli
## Getting Started
### Gradle
Add dependencies:
Add dependencies (see bintray badge, above, for latest version number such as `1.0.0-beta07` ) :
```groovy
dependencies {
implementation 'cash.z.ecc.android:android-bip39:1.0.0-beta02'
implementation "cash.z.ecc.android:android-bip39:${latestVersion}"
}
repository {
@ -42,6 +44,8 @@ This library prefers `CharArrays` over `Strings` for [added security](https://st
Note: If strings or lists are desired, it is very easy (but not recommended) to convert to/from a CharArray via `String(charArray)` or `String(charArray).split(' ')` .
* Create new 24-word mnemonic phrase
```kotlin
import cash.z.ecc.android.bip39.Mnemonics.MnemonicCode
val mnemonicCode: MnemonicCode = MnemonicCode(WordCount.COUNT_24)
// assert: mnemonicCode.wordCount == 24, mnemonicCode.languageCode == "en"
@ -5,7 +5,7 @@ object Deps {
// `Deps.Kotlin.version` directly
const val kotlinVersion = " 1.3.72 "
const val group = " cash.z.ecc.android "
const val versionName = " 1.0.0-beta06 "
const val versionName = " 1.0.0-beta07 "
const val description = " A concise implementation of BIP-0039 in Kotlin for Android. "
object Kotlin : Version ( kotlinVersion ) {
@ -78,7 +78,6 @@ def pomConfig = {
}
}
// Jar containing Kotlin sources
task sourcesJar ( type: Jar ) {
archiveClassifier = 'sources'
@ -93,16 +92,6 @@ task docsJar(type: Jar) {
from dokka
}
task javadocJar ( type: Jar , dependsOn: javadoc ) {
archiveClassifier = 'javadoc'
from javadoc . destinationDir
}
artifacts {
archives sourcesJar
archives docsJar
}
publishing {
publications {
Production ( MavenPublication ) {
@ -128,7 +117,6 @@ bintray {
user = project . hasProperty ( 'bintrayUser' ) ? : System . getenv ( 'BINTRAY_USER' )
key = project . hasProperty ( 'bintrayApiKey' ) ? : System . getenv ( 'BINTRAY_API_KEY' )
publications = [ 'Production' ]
configurations = [ 'archives' ]
override = true
pkg {
repo = 'android-bip39'
@ -142,7 +130,7 @@ bintray {
dryRun = false
version {
name = Deps . versionName
desc = "v${this.version}"
desc = Deps . description
released = new Date ( )
vcsTag = this . version
}