From 37cc59fef022cf52c7d8a272f220add43b5ee969 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Cl=C3=A9ment=20=27birdy=27=20Danjou?= <clement@danjou.io>
Date: Thu, 8 Aug 2024 01:39:08 +0200
Subject: [PATCH] docs: add a README

---
 README.md | 111 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 111 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..14f99c2d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,111 @@
+<p align="center">
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/zama-ai/fhevm/assets/157474013/b07e7e65-12b2-4048-b5de-35e169ed96e4">
+  <source media="(prefers-color-scheme: light)" srcset="https://github.com/zama-ai/fhevm/assets/157474013/c0fab5b1-adef-4db4-9607-fa0a793acaf8">
+  <img width=600 alt="Zama fhEVM">
+</picture>
+</p>
+
+<hr/>
+
+<p align="center">
+  <a href="https://github.com/zama-ai/fhevm/blob/main/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>
+
+<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="https://github.com/zama-ai/fhevm/blob/main/LICENSE">
+    <!-- markdown-link-check-disable-next-line -->
+    <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">
+    <!-- markdown-link-check-disable-next-line -->
+    <img src="https://img.shields.io/badge/Contribute-Zama%20Bounty%20Program-%23ffd208?style=flat-square"></a>
+  <a href="https://slsa.dev"><img alt="SLSA 3" src="https://slsa.dev/images/gh-badge-level3.svg" /></a>
+</p>
+
+### Documentation
+
+Full, comprehensive documentation is available here: [https://docs.zama.ai/fhevm-backend](https://docs.zama.ai/fhevm-backend).
+
+<p align="right">
+  <a href="#about" > ↑ Back to top </a>
+</p>
+
+### 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"
+}
+```
+
+### Contributing
+
+There are two ways to contribute to the Zama fhEVM:
+
+- [Open issues](https://github.com/zama-ai/fhevm-backend/issues/new/choose) to report bugs and typos, or to suggest new ideas
+- Request to become an official contributor by emailing hello@zama.ai.
+
+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>
+
+### License
+
+This software is distributed under the **BSD-3-Clause-Clear** license. Read [this](LICENSE) for more details.
+
+#### FAQ
+
+**Is Zama’s technology free to use?**
+
+> Zama’s libraries are free to use under the BSD 3-Clause Clear license only for development, research, prototyping, and experimentation purposes. However, for any commercial use of Zama's open source code, companies must purchase Zama’s commercial patent license.
+>
+> Everything we do is open source and we are very transparent on what it means for our users, you can read more about how we monetize our open source products at Zama in [this blog post](https://www.zama.ai/post/open-source).
+
+**What do I need to do if I want to use Zama’s technology for commercial purposes?**
+
+> To commercially use Zama’s technology you need to be granted Zama’s patent license. Please contact us at hello@zama.ai for more information.
+
+**Do you file IP on your technology?**
+
+> Yes, all Zama’s technologies are patented.
+
+**Can you customize a solution for my specific use case?**
+
+> We are open to collaborating and advancing the FHE space with our partners. If you have specific needs, please email us at hello@zama.ai.
+
+<p align="right">
+  <a href="#table-of-contents" > ↑ Back to top </a>
+</p>
+
+## Support
+
+<a target="_blank" href="https://community.zama.ai">
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/zama-ai/fhevm/assets/157474013/e249e1a8-d724-478c-afa8-e4fe01c1a0fd">
+  <source media="(prefers-color-scheme: light)" srcset="https://github.com/zama-ai/fhevm/assets/157474013/a72200cc-d93e-44c7-81a8-557901d8798d">
+  <img alt="Support">
+</picture>
+</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>