Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: Add top-level installation guide #146

Merged
merged 1 commit into from
Aug 13, 2024
Merged

chore: Add top-level installation guide #146

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,36 @@ A cryptographic library that is compatible with the KZG commitment scheme used i

The cryptography implemented in this library is the prerequisite needed for Ethereum's version of Data Availability Sampling(DAS). The library has been implemented in a modular way, so one can also use the underlying polynomial commitment scheme, for a different purpose.

## Installation

### Rust

```
cargo add rust_eth_kzg
```

### Node

```
npm i @crate-crypto/node-eth-kzg
```

### Java

```
pkg:maven/io.github.crate-crypto/[email protected]
```

### CSharp

```
dotnet add package EthKZG.Bindings
```

### Nim

> Use the github URL for Nim.

## Building the source

This library is written in Rust and offers bindings to C, C#, node.js, golang, Java and Nim. These bindings can be found in the `bindings` folder. The bindings expose an API that is compatible with the API needed for Ethereum.
Expand Down
Loading