Skip to content
Snippets Groups Projects
Unverified Commit a49b4a95 authored by STEVAN Antoine's avatar STEVAN Antoine 🦀
Browse files

add a few instructions on how to use `komodo`

parent b83361f8
No related branches found
No related tags found
No related merge requests found
# Komodo: Cryptographically-proven Erasure Coding
## Usage
Komodo can either be used as a library or as a binary application.
## the library
see `cargo doc`
## the binary application
below is an example of how to use the binary application with Nushell:
```bash
use komodo.nu [
"komodo build",
"komodo setup",
"komodo prove",
"komodo verify",
"komodo reconstruct",
]
use binary.nu [ "bytes decode" ]
let bytes = open komodo.nu
komodo build
komodo setup $bytes
komodo prove $bytes --fec-params {k: 3, n: 5}
komodo verify blocks/0.bin blocks/1.bin
(komodo reconstruct blocks/0.bin blocks/2.bin blocks/3.bin | bytes decode) == $bytes
```
`true` should be printed at the end :thumbsup:
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment