Skip to content

Commit

Permalink
docs: add initial Gitbook version
Browse files Browse the repository at this point in the history
  • Loading branch information
aquint-zama committed Jan 26, 2024
1 parent 3dd1995 commit 6fd3bbe
Show file tree
Hide file tree
Showing 7 changed files with 433 additions and 292 deletions.
284 changes: 0 additions & 284 deletions Integration.md

This file was deleted.

15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
</p>
<hr/>
<p align="center">
<a href="https://docs.zama.ai/fhevm"> 📒 Read documentation</a> | <a href="https://zama.ai/community"> 💛 Community support</a>
<a href="https://docs.zama.ai/fhevm-go"> 📒 Read documentation</a> | <a href="https://zama.ai/community"> 💛 Community support</a>
</p>
<p align="center">
<!-- Version badge using shields.io -->
Expand All @@ -18,12 +18,12 @@
</p>
<hr/>

**fhevm-go** is an open-source library used to easily integrate the [fhEVM](https://docs.zama.ai/fhevm) into an EVM-compatible blockchain.
**fhEVM-go** is an open-source library used to easily integrate the [fhEVM](https://docs.zama.ai/fhevm) into an EVM-compatible blockchain.


## Main features

fhevm-go gives your EVM the ability to compute on encrypted data using fully homomorphic encryption by:
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

Expand Down Expand Up @@ -55,20 +55,19 @@ replace(
```

> [!NOTE]
> 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`
> 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

Full, comprehensive documentation is available at [https://docs.zama.ai/fhevm](https://docs.zama.ai/fhevm) (still nothing about fhevm-go however).
Full, comprehensive documentation is available at [https://docs.zama.ai/fhevm-go](https://docs.zama.ai/fhevm-go).

## Target users

The library helps EVM maintainers to extend their EVM with the power of FHE. If you are looking for a library to deploy and use smart contracts on an fhEVM, you should better look at [https://github.com/zama-ai/fhevm](https://github.com/zama-ai/fhevm-go/releases)
The library helps EVM maintainers to extend their EVM with the power of FHE. If you are looking for a library to deploy and use smart contracts on an fhEVM, you should better look at [https://github.com/zama-ai/fhevm](https://github.com/zama-ai/fhevm).

## Tutorials

- [Integration guide](Integration.md)
- Idea: video doing the integration
- [Integration guide](https://docs.zama.ai/fhevm-go/getting-started/integration)

## Need support?

Expand Down
22 changes: 22 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Overview

📁 [Github](https://github.com/zama-ai/fhevm-go) | 💛 [Community support](https://zama.ai/community) | 🟨 [Zama Bounty Program](https://github.com/zama-ai/bounty-program)

<figure><img src="_static/zama_doc_header_fhevm.png" alt=""><figcaption></figcaption></figure>

**fhevm-go** is an open-source library used to easily integrate the [fhEVM](https://docs.zama.ai/fhevm) into an EVM-compatible blockchain.


## Main features

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

## Target users

The library helps EVM maintainers to extend their EVM with the power of FHE. If you are looking for a library to deploy and use smart contracts on an fhEVM, you should better look at [fhevm](https://docs.zama.ai/fhevm)

## License

This software is distributed under the BSD-3-Clause-Clear license. If you have any questions, please contact us at hello@zama.ai.
17 changes: 17 additions & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Table of contents

## What is fhEVM-go
- [Overview](README.md)

## Getting Started
- [Initial Setup](getting_started/README.md)
- [Integration](getting_started/Integration.md)

## 🔗 Support

- [Community forum](https://community.zama.ai)
- [Telegram](https://t.me/+Ojt5y-I7oR42MTkx)
- [FHE.org discord](https://discord.fhe.org)
<!-- markdown-link-check-disable -->
- [Twitter](https://twitter.com/zama_fhe)
<!-- markdown-link-check-enable -->
Binary file added docs/_static/zama_doc_header_fhevm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 6fd3bbe

Please sign in to comment.