Skip to content

Commit

Permalink
chore: edit readme with suggestions
Browse files Browse the repository at this point in the history
Co-authored-by: Petar Ivanov <[email protected]>
  • Loading branch information
youben11 and dartdart26 committed Jan 24, 2024
1 parent 7f489fb commit 3dd1995
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Integration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Integration

This document is a guide listing detailed steps to integrate [fhevm-go](https://github.com/zama-ai/fhevm-go) into [go-ethereum](https://github.com/ethereum/go-ethereum) or any other implementations that follows the same architecture.
This document is a guide listing detailed steps to integrate [fhevm-go](https://github.com/zama-ai/fhevm-go) into [go-ethereum](https://github.com/ethereum/go-ethereum) or any other implementations that follow the same architecture.

> [!NOTE]
> This document is based on go-ethereum v1.13.5
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@

## Main features

Give your EVM the ability to compute on encrypted data using homomorphic encryption.
- Support of a large collections of encrypted operations via precompiled contracts
- Ready to use EVM components that supports encrypted computation
fhevm-go gives your EVM the ability to compute on encrypted data using fully homomorphic encryption by:
- a collection of operations on encrypted data via precompiled contracts
- various additional EVM components that support encrypted computation


## Getting started

In order to use the library, you need to clone the repository and build it. This is required because the library depends on another library that needs to be built from source (for now), and Go doesn't support such build.
In order to use the library, you need to clone the repository and build it. This is required because the library depends on the `tfhe-rs` library that needs to be built from source (for now), and Go doesn't support such a build.
```bash
$ git clone https://github.com/zama-ai/fhevm-go
$ cd fhevm-go
Expand All @@ -55,7 +55,7 @@ replace(
```

> [!NOTE]
> The replace in necessary for now as Go build system can't build the third party library that `fhevm-go` needs. It's therefore necessary that we build it manually as mentioned above, then point to our ready-to-use directory in `go.mod`
> The replace in necessary for now as Go build system can't build the `tfhe-rs` library that `fhevm-go` needs. It's therefore necessary that we build it manually as mentioned above, then point to our ready-to-use directory in `go.mod`
## Documentation

Expand Down

0 comments on commit 3dd1995

Please sign in to comment.