Merge pull request #54 from PacificYield/docs

docs: updates

README.md

@@ -1,16 +1,9 @@
 # fhEVM Contracts
 
-<p align="center">
-  <a href="./fhevm-whitepaper.pdf"> 📃 Read white paper</a> |<a href="https://docs.zama.ai/fhevm"> 📒 Documentation</a> | <a href="https://zama.ai/community"> 💛 Community support</a> | <a href="https://github.com/zama-ai/awesome-zama"> 📚 FHE resources by Zama</a>
-</p>
+## Description
 
-<p align="center">
-  <a href="https://github.com/zama-ai/fhevm/releases"><img src="https://img.shields.io/github/v/release/zama-ai/fhevm?style=flat-square"></a>
-  <a href="license"><img src="https://img.shields.io/badge/License-BSD--3--Clause--Clear-%23ffb243?style=flat-square"></a>
-  <a href="https://github.com/zama-ai/bounty-program"><img src="https://img.shields.io/badge/Contribute-Zama%20Bounty%20Program-%23ffd208?style=flat-square"></a>
-</p>
-
-fhEVM contracts is a library for encrypted smart contract development on fhEVM.
+fhEVM contracts is a Solidity library for secure smart-contract development using
+[fhEVM](https://github.com/zama-ai/fhevm) and TFHE.
 
 ## Getting Started
 
@@ -39,7 +32,8 @@ import "fhevm-contracts/contracts/token/ERC20/EncryptedERC20.sol";
 
 contract MyERC20 is EncryptedERC20 {
   constructor() EncryptedERC20("MyToken", "MYTOKEN") {
-    _mint(1000000, msg.sender);
+    TFHE.setFHEVM(FHEVMConfig.defaultConfig());
+    _unsafeMint(1000000, msg.sender);
   }
 }
 ```
@@ -48,61 +42,20 @@ contract MyERC20 is EncryptedERC20 {
 
 ### Documentation
 
-Full, comprehensive documentation is available here: [https://docs.zama.ai/fhevm](https://docs.zama.ai/fhevm).
-
-### Citations
-
-To cite fhEVM or the whitepaper in academic papers, please use the following entries:
-
-```text
-@Misc{fhEVM,
-title={{Private smart contracts on the EVM using homomorphic encryption}},
-author={Zama},
-year={2023},
-note={\url{https://github.com/zama-ai/fhevm}},
-}
-```
-
-```text
-@techreport{fhEVM,
-author = "Morten Dahl, Clément Danjou, Daniel Demmler, Tore Frederiksen, Petar Ivanov,
-Marc Joye, Dragos Rotaru, Nigel Smart, Louis Tremblay Thibault
-",
-title = "Confidential EVM Smart Contracts using Fully Homomorphic Encryption",
-institution = "Zama",
-year = "2023"
-}
-```
+The full documentation is available [here](https://docs.zama.ai/fhevm).
 
 ### Contributing
 
 There are two ways to contribute to the Zama fhEVM contracts:
 
 - [Open issues](https://github.com/zama-ai/fhevm-contracts/issues/new/choose) to report bugs and typos, or to suggest
-  new ideas
+  new ideas.
 - Request to become an official contributor by emailing [email protected].
 
-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>
+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.
 
 ### License
 
-This software is distributed under the **BSD-3-Clause-Clear** license. If you have any questions, please contact us at
-[email protected].
-
-<p align="right">
-  <a href="#table-of-contents" > ↑ Back to top </a> 
-</p>
-
-## Support
-
-<a target="_blank" href="https://community.zama.ai">
-  <img src="https://github.com/zama-ai/fhevm/assets/157474013/4e75e34e-df3f-4e9e-8a22-12b1d4013578">
-</a>
-
-🌟 If you find this project helpful or interesting, please consider giving it a star on GitHub! Your support helps to
-grow the community and motivates further development.
-
-<p align="right">
-  <a href="#about" > ↑ Back to top </a> 
-</p>
+This software is distributed under the **BSD-3-Clause-Clear** license. If you have any question about the license,
+please contact us at [email protected].

contracts/governance/GovernorAlphaZama.sol

@@ -121,6 +121,7 @@ abstract contract GovernorAlphaZama is Ownable2Step, GatewayCaller {
 
     /**
      * @param proposer              Proposal creator.
+     * @param state                 State of the proposal.
      * @param eta                   The timestamp that the proposal will be available for execution,
      *                              it is set automatically once the vote succeeds.
      * @param targets               The ordered list of target addresses for calls to be made.