Skip to content

Commit

Permalink
docs: fix some links in Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yuxizama authored Feb 6, 2024
1 parent c545803 commit 57362c6
Showing 1 changed file with 12 additions and 13 deletions.
25 changes: 12 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<img src="https://img.shields.io/github/v/release/zama-ai/fhevm?style=flat-square">
</a>
<!-- License badge -->
<a href="#license">
<a href="#-license">
<img src="https://img.shields.io/badge/License-BSD--3--Clause--Clear-orange?style=flat-square">
</a>
<!-- Zama Bounty Program -->
Expand All @@ -34,7 +34,7 @@
- [Demos](#-demos)
- [Tutorials](#-tutorials)
- [Documentation](#-documentation)
- **[Working with fhEVM](working-with-fhevm)**
- **[Working with fhEVM](#working-with-fhevm)**
- [Development guide](#-development-guide)
- [Citations](#-citations)
- [Contributing](#-contributing)
Expand All @@ -47,9 +47,7 @@

### 🟨 What is fhEVM

**fhEVM** enables confidential smart contracts using fully homomorphic encryption (FHE).

Blockchain developers used to face a dilemma: whether keep the application and user data on-chain where everyone can see it, or keep it privately off-chain and lose the contract composability.
**fhEVM** is a technology that enables confidential smart contracts on the EVM using fully homomorphic encryption (FHE).

Thanks to a breakthrough in homomorphic encryption, Zama’s fhEVM makes it possible to run confidential smart contracts on encrypted data, guaranteeing both confidentiality and composability with:
- **End-to-end encryption of transactions and state:** Data included in transactions is encrypted and never visible to anyone.
Expand All @@ -69,7 +67,7 @@ Thanks to a breakthrough in homomorphic encryption, Zama’s fhEVM makes it poss
- **Configurable Decryption :** Threshold, centralized or KMS decryption
- **Unbounded Compute Depth :** Unlimited consecutive FHE operations

*Learn more features in fhEVM's [documentation](https://docs.zama.ai/fhevm/readme).*
*Learn more features in fhEVM's [documentation](https://docs.zama.ai/fhevm).*
<br></br>

### 🟨 Use cases
Expand All @@ -83,7 +81,7 @@ fhEVM is built for developers to write confidential smart contracts without lear
- **Encrypted DIDs**: Store identities on-chain and generate attestations without ZK.
- **Private transfers**: Keep balances and amounts private, without using mixers.

*Learn more use cases in our [list of examples](https://docs.zama.ai/fhevm/resources/examples).*
*Learn more use cases in the [list of examples](https://docs.zama.ai/fhevm/resources/examples).*

<p align="right">
<a href="#table-of-contents" > ↑ Back to top </a>
Expand Down Expand Up @@ -132,7 +130,7 @@ contract Counter {
}
```

*See our documentation on [https://docs.zama.ai/fhevm/writing-contract/getting_started](https://docs.zama.ai/fhevm/how-to/write_contract) for more details.*
*This example is explained in more detail in [this section of the documentation](https://docs.zama.ai/fhevm/how-to/write_contract).*
<p align="right">
<a href="#table-of-contents" > ↑ Back to top </a>
</p>
Expand Down Expand Up @@ -169,7 +167,7 @@ If you have built awesome projects using fhEVM, feel free to let us know and we'
- [Confidential ERC-20 Tokens Using Homomorphic Encryption and the fhEVM](https://www.zama.ai/post/confidential-erc-20-tokens-using-homomorphic-encryption)
- [Programmable Privacy and Onchain Compliance using Homomorphic Encryption](https://www.zama.ai/post/programmable-privacy-and-onchain-compliance-using-homomorphic-encryption)

*Explore more useful resources in fhEVM [tutorials](https://docs.zama.ai/fhevm/resources/tutorials) and [Awesome Zama repo](https://github.com/zama-ai/awesome-zama)*
*Explore more useful resources in [fhEVM tutorials](https://docs.zama.ai/fhevm/resources/tutorials) and [Awesome Zama repo](https://github.com/zama-ai/awesome-zama)*
<br></br>

### 🟨 Documentation
Expand Down Expand Up @@ -278,7 +276,8 @@ TARGET_NETWORK=Network1 npx ts-node codegen/main.ts && npm run prettier
# run tests for network1 network, assumes network1 rpc already running locally
npx hardhat test --network localNetwork1
```
<br></br>


#### Adding new operators

Operators can be defined as data inside `codegen/common.ts` file and code automatically generates solidity overloads.
Expand Down Expand Up @@ -331,10 +330,10 @@ year = "2023"

There are two ways to contribute to the Zama fhEVM:

- O[pen issues](https://github.com/zama-ai/fhevm/issues/new/choose) to report bugs and typos, or to suggest new ideas
- Request to become an official contributor by emailing [email protected]. (becoming an approved contributor involves signing our Contributor License Agreement (CLA))
- [Open issues](https://github.com/zama-ai/fhevm/issues/new/choose) to report bugs and typos, or to suggest new ideas
- Request to become an official contributor by emailing [email protected].

Only approved contributors can send pull requests, so please make sure to get in touch before you do!
Becoming an approved contributor involves signing our Contributor License Agreement (CLA)). Only approved contributors can send pull requests, so please make sure to get in touch before you do!
<br></br>


Expand Down

0 comments on commit 57362c6

Please sign in to comment.