-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
03b80f3
commit 5fcc333
Showing
1 changed file
with
41 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,21 @@ | ||
# fhevmjs | ||
|
||
![Main](https://github.com/github/docs/actions/workflows/main.yml/badge.svg) | ||
<p align="center"> | ||
<img width=600 src="https://github.com/zama-ai/fhevmjs/assets/1384478/b0696934-3eee-44af-a2db-8e77094a40b6" /> | ||
</p> | ||
<hr/> | ||
<p align="center"> | ||
<a href="https://docs.zama.ai/fhevm"> 📃 Read white paper</a> |<a href="https://docs.zama.ai/fhevm"> 📒 Read documentation</a> | <a href="https://zama.ai/community"> 💛 Community support</a> | ||
</p> | ||
<p align="center"> | ||
<!-- Version badge using shields.io --> | ||
<a href="https://github.com/zama-ai/fhevmjs/releases"> | ||
<img src="https://img.shields.io/github/v/release/zama-ai/fhevmjs?style=flat-square"> | ||
</a> | ||
<!-- Zama Bounty Program --> | ||
<a href="https://github.com/zama-ai/bounty-program"> | ||
<img src="https://img.shields.io/badge/Contribute-Zama%20Bounty%20Program-yellow?style=flat-square"> | ||
</a> | ||
</p> | ||
<hr/> | ||
|
||
fhevmjs is a javascript library that enables developers to interact with blockchains using Zama's cutting-edge technology based on TFHE (Fully Homomorphic Encryption over the Torus). This library provides a seamless integration of TFHE encryption capabilities into web3 applications, allowing for secure and private interactions with smart contracts. | ||
|
||
|
@@ -12,10 +27,31 @@ npm install fhevmjs | |
|
||
# Using Yarn | ||
yarn add fhevmjs | ||
|
||
# Using pnpm | ||
yarn add pnpm | ||
``` | ||
|
||
This will download and install the fhevmjs library and its dependencies into your project. | ||
|
||
## Documentation | ||
## Contributing | ||
|
||
There are two ways to contribute to the Zama fhEVM: | ||
|
||
- you can open issues to report bugs or typos, or to suggest new ideas | ||
- you can ask 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! | ||
|
||
## Credits | ||
|
||
This library uses several dependencies and we would like to thank the contributors of those libraries. | ||
|
||
## Need support? | ||
<a target="_blank" href="https://community.zama.ai"> | ||
<img src="https://github.com/zama-ai/fhevmjs/assets/1384478/4fc4e460-ca1d-4910-8bc2-cd1d50c7d020"> | ||
</a> | ||
|
||
## License | ||
|
||
fhevmjs library is documented in [the documentation of fhEVM](https://docs.zama.ai/fhevm/). | ||
This software is distributed under the BSD-3-Clause-Clear license. If you have any questions, | ||
please contact us at `[email protected]`. |