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

Changing README
Some checks are pending
Build project and push to maven snapshot / Build-And-Push-Linux (push) Waiting to run
Details
Build project and push to maven snapshot / Build-And-Push-Mac (push) Waiting to run
Details
Build project and push to maven snapshot / Build-And-Push-Windows (push) Waiting to run
Details

Browse Source
This commit is contained in:
kildishevps 2025-02-04 21:40:56 +03:00
parent f1b8488707
commit 2acf7218b4
1 changed files with 4 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -13,20 +13,12 @@ attack surfaces, bugs and other issues and you shouldn't use it in production un
#### Gradle
```kotlin
implementation("com.ionspin.kotlin:multiplatform-crypto-libsodium-bindings:0.9.2")
```
#### Snapshot builds
```kotlin
repositories {
maven("https://oss.sonatype.org/content/repositories/snapshots")
maven("https://gitea.sergeych.net/api/packages/YoungBlood/maven")
}
implementation("com.ionspin.kotlin:multiplatform-crypto-libsodium-bindings:0.9.3-SNAPSHOT")
implementation("net.sergeych:multiplatform-crypto-libsodium-bindings:0.9.4-SNAPSHOT")
```
## Usage
Before using the wrapper you need to initialize the underlying libsodium library. You can use either a callback or coroutines approach
@ -146,7 +138,7 @@ Currently supported native platforms (Apple Silicon is supported since 0.8.5) :
Android .so files come from running dist-build scripts in libsodium which you can find in the libsodium submodule
Java Linux Arm/X86_64 and Mac so and dylib are the same as produced by multiplatform builds, also based on the same submodule commit
Java Windows dll is from https://download.libsodium.org/libsodium/releases/libsodium-1.0.19-stable-msvc.zip
Javascript is from libsodium-wrappers-sumo npm package version 0.7.13 (https://github.com/jedisct1/libsodium.js)
Javascript and WebAssembly is from libsodium-wrappers-sumo npm package version 0.7.13 (https://github.com/jedisct1/libsodium.js)
### TODO:
- Improve documentation
@ -156,7 +148,7 @@ Javascript is from libsodium-wrappers-sumo npm package version 0.7.13 (https://g
- Find a better way of fetching Konan dependencies than having a dummy project.
### Building
Clone the git, init the submodule and run `./gradlew build`. Note that current build settings are such that only linux builds `js` target.
Clone the git, init the submodule and run `./gradlew build`. Note that current build settings are such that only linux builds `js` and `wasmJs` targets.
#### Notes for Github runners:
- At the moment all runners need to have android sdk present even though not all are building Android build