diff --git a/Integration.md b/Integration.md index f88abd3..dc8414e 100644 --- a/Integration.md +++ b/Integration.md @@ -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 diff --git a/README.md b/README.md index 93cc16e..1e7d2cc 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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