diff --git a/README.md b/README.md index a779efb..3eeb829 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,76 @@ # ergo-lib-go Go wrapper around C bindings for ErgoLib from [sigma-rust](https://github.com/ergoplatform/sigma-rust) -### Status -Package is still work in progress and will likely change in the future +### Install +``` +go get -u https://github.com/sigmaspace-io/ergo-lib-go +``` + +### Supported Platforms +This library makes heavy use of cgo. A set of precompiled shared library objects are provided. For the time being the following platforms are supported and tested against: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PlatformArchitectureTripleSupportedTested
Linuxamd64x86_64-unknown-linux-gnu
aarch64aarch64-unknown-linux-gnu
Darwinamd64x86_64-apple-darwin
aarch64aarch64-apple-darwin
Windowsamd64x86_64-pc-windows-msvc
+ +### Supported sigma-rust versions + + + + + + + + + + + + + +
sigma-rust Versionergo-lib-go Version
v0.26.0v0.26.0
### Library The libraries under `lib` where compiled from `sigma-rust` with the following commands: