YoungBlood/libsodium_wasm_experimental
3
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Ugljesa Jovanovic 2020-06-13 16:31:14 +02:00
parent c5cb66d087
commit f24b817bad
No known key found for this signature in database
GPG Key ID: 178E6DFCECCB0E0F
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -32,7 +32,9 @@ APIs of both variants are identical.
|minGW X86 64| :heavy_check_mark: | :heavy_check_mark: | |minGW X86 64| :heavy_check_mark: | :heavy_check_mark: |
|minGW X86 32| :x: | :x: | |minGW X86 32| :x: | :x: |
## Sample project
The library includes sample project that shows usage on different platforms
- NOTE: Currently only linux, macOs and windows are included.
## Notes & Roadmap ## Notes & Roadmap
@ -40,6 +42,8 @@ APIs of both variants are identical.
Next steps: Next steps:
- Expand API (AEAD, ECC ...) - Expand API (AEAD, ECC ...)
- Include AES and Argon2 in new API approach
- Add primitives missing in `delegated` variant that are supported in `pure` (at the moment AES and Argon2)
## Should I use this in production? ## Should I use this in production?
@ -88,14 +92,17 @@ The following table describes which library is used for particular cryptographic
## Integration ## Integration
NOTE: Latest version of the library is built with Kotlin 1.4-M2 and therefore only SNAPSHOT variant is available. Next
stable version will be released when Kotlin 1.4. is released
#### Gradle #### Gradle
Kotlin Kotlin
```kotlin ```kotlin
implementation("com.ionspin.kotlin:multiplatform-crypto:0.0.5") implementation("com.ionspin.kotlin:multiplatform-crypto:0.1.0")
or or
implementation("com.ionspin.kotlin:multiplatform-crypto-delegated:0.0.5") implementation("com.ionspin.kotlin:multiplatform-crypto-delegated:0.1.0")
``` ```
#### Snapshot builds #### Snapshot builds
@ -105,7 +112,7 @@ repositories {
url = uri("https://oss.sonatype.org/content/repositories/snapshots") url = uri("https://oss.sonatype.org/content/repositories/snapshots")
} }
} }
implementation("com.ionspin.kotlin:multiplatform-crypto:0.0.6-SNAPSHOT") implementation("com.ionspin.kotlin:multiplatform-crypto:0.1.0-SNAPSHOT")
``` ```