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 e9ccfec
Show file tree
Hide file tree
Showing 6 changed files with 426 additions and 284 deletions.
284 changes: 0 additions & 284 deletions Integration.md

This file was deleted.

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 e9ccfec

Please sign in to comment.