Skip to content

Commit

Permalink
doc: update readme with install instructions (#336)
Browse files Browse the repository at this point in the history
  • Loading branch information
milapsheth authored Jul 11, 2024
1 parent 335bfb1 commit 5969573
Showing 1 changed file with 21 additions and 12 deletions.
33 changes: 21 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,7 @@

Tofnd is a [gRPC](https://grpc.io/) server written in Rust that wraps the [tofn](https://github.com/axelarnetwork/tofn) cryptography library.

## Setup

```bash
git clone git@github.com:axelarnetwork/tofnd.git --recursive
```
## Install

Install `protoc`

Expand All @@ -18,16 +14,32 @@ sudo apt install protobuf-compiler
brew install protobuf
```

## Build binaries
### Cargo

```bash
cargo install tofnd
```

### Releases

Pre-built releases can be found [here](https://github.com/axelarnetwork/tofnd/releases)

To build yourself, run:
### Source

```bash
cargo build --release --locked
git clone git@github.com:axelarnetwork/tofnd.git --recursive
```

```bash
cargo install --locked --path .
```

```bash
./target/release/tofnd --version
```

## Development

Run tests:

```bash
Expand All @@ -43,10 +55,7 @@ GOLDIE_UPDATE=1 cargo test --release
## Running the server

```bash
# install tofnd at ./target/release/tofnd
cargo install --locked --path . && cd ./target/release

# init tofnd
# Initialize tofnd
./tofnd -m create

# IMPORTANT: store the content of ./.tofnd/export file at a safe, offline place, and then delete the file
Expand Down

0 comments on commit 5969573

Please sign in to comment.