From a951f3ad71e3fec493a214e97033b407d949e84f Mon Sep 17 00:00:00 2001 From: Knut Ahlers Date: Sat, 24 Aug 2019 17:18:23 +0200 Subject: [PATCH] Update README Signed-off-by: Knut Ahlers --- README.md | 31 +++---------------------------- 1 file changed, 3 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 2aafb56..e6439ac 100644 --- a/README.md +++ b/README.md @@ -7,38 +7,13 @@ `wasm-openssl` is a WASM wrapper around [go-openssl](https://github.com/Luzifer/go-openssl) to be used in Javascript projects. -**A word of warning:** This relies on the **experimental** WASM implementation in Golang. It is working but most likely will not have its final state. When the Golang implementation of WASM changes this likely will change too. Following SemVer every breaking change will have an increase of the major version with an explanation in the [changelog](History.md). +**A word of warning:** This relies on the **experimental** WASM implementation in Golang. It is working but most likely will not have its final state. When the Golang implementation of WASM changes this likely will change too. As long as the WASM implementation in Go is experimental this only serves as a proof-of-concept and maybe shouldn't be used in production! ## Usage -You will need to have `wasm_exec.js` installed in your project to load the binary: +You will need to have `wasm_exec.js` installed in your project to load the binary. This file can be found in [golang/go](https://github.com/golang/go/tree/master/misc/wasm) repository. (Make sure the version of the file matches the version of Go used to compile the WASM file. -```console -$ curl -sSfLo wasm_exec.js "https://raw.githubusercontent.com/golang/go/go1.11/misc/wasm/wasm_exec.js" -``` - -Afterwards in your HTML you can include the `wasm_exec.js` and load the binary: - -```html - - - - - - - - - - -``` +For an embedding example see the `example` folder in this repo. If you have a top-level function `opensslLoaded()` defined, this will be called in the initialization of the `openssl.wasm`. This serves as a notification you do have now access to the top-level functions `opensslEncrypt` and `opensslDecrypt`: