Skip to content

Commit

Permalink
chore: add Android Support to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
overcat committed Aug 18, 2024
1 parent 063f522 commit 8423389
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,25 @@ Mnemonic mnemonic = new Mnemonic(Language.ENGLISH, customWords);
String words = mnemonic.generate();
```

## Android Support

The library works well on Android platforms:

- For Android platforms with API level 26 and above, no additional configuration is required.
- For versions below Android API 26, due to the lack of support for
certain necessary cryptographic algorithms, you need to include the following dependency:

```kotlin
implementation("org.bouncycastle:bcprov-jdk18on:1.78.1")
```

Additionally, add the following lines of code to your Android project:

```kotlin
Security.removeProvider(BouncyCastleProvider.PROVIDER_NAME)
Security.addProvider(BouncyCastleProvider() as Provider?)
```

## License

This library is released under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
Expand Down

0 comments on commit 8423389

Please sign in to comment.