diff --git a/README.md b/README.md index b86e319ae..4a4dfd907 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ ![](./docs/source/.static/img/nucypher.png) -*A decentralized cryptological network offering accessible, intuitive, and extensible runtimes and interfaces for secrets management and dynamic access control.* +*A decentralized cryptological network offering accessible, intuitive, and extensible runtimes and interfaces for +secrets management and dynamic access control.* [![pypi](https://img.shields.io/pypi/v/nucypher.svg?style=flat)](https://pypi.org/project/nucypher/) [![pyversions](https://img.shields.io/pypi/pyversions/nucypher.svg)](https://pypi.org/project/nucypher/) @@ -10,49 +11,36 @@ ---- -# Whitepapers +# TACo Access Control -### Network - -[*"NuCypher - A proxy re-encryption network to empower privacy in decentralized systems"*](https://github.com/nucypher/whitepaper/blob/master/whitepaper.pdf) - -*by Michael Egorov, David Nuñez, and MacLane Wilkison - NuCypher* - -### Economics - -[*"NuCypher - Staking Protocol & Economics"*](https://github.com/nucypher/whitepaper/blob/master/economics/staking_protocol/NuCypher_Staking_Protocol_Economics.pdf) - -*by Michael Egorov, MacLane Wilkison, Arjun Hassard - NuCypher* - - -[*"NuCypher - Pricing Protocol & Economics"*](https://github.com/nucypher/whitepaper/blob/master/economics/pricing_protocol/NuCypher_Network__Pricing_Protocol_Economics.pdf) - -*by Arjun Hassard - NuCypher* - -### Cryptography - -[*"Umbral: A Threshold Proxy Re-Encryption Scheme"*](https://github.com/nucypher/umbral-doc/blob/master/umbral-doc.pdf) - -*by David Nuñez* +TACo (Threshold Access Control) is end-to-end encrypted data sharing and communication, without the requirement of +trusting a centralized authority, who might unilaterally deny service or even decrypt private user data. It is the only +access control layer available to Web3 developers that can offer a decentralized service, through a live, +well-collateralized and battle-tested network. See more here: [https://docs.threshold.network/applications/threshold-access-control](https://docs.threshold.network/applications/threshold-access-control) # Getting Involved NuCypher is a community-driven project and we're very open to outside contributions. -All our development discussions happen in our [Discord server](https://discord.gg/7rmXa3S), where we're happy to answer technical questions, discuss feature requests, +All our development discussions happen in our [Discord server](https://discord.gg/7rmXa3S), where we're happy to answer +technical questions, discuss feature requests, and accept bug reports. -If you're interested in contributing code, please check out our [Contribution Guide](https://docs.nucypher.com/en/latest/support/contribution.html) +If you're interested in contributing code, please check out +our [Contribution Guide](https://docs.nucypher.com/en/latest/support/contribution.html) and browse our [Open Issues](https://github.com/nucypher/nucypher/issues) for potential areas to contribute. Get up and running quickly by using our [docker development setup](dev/docker/README.md) # Security -If you identify vulnerabilities with _any_ nucypher code, please email security@nucypher.com with relevant information to your findings. -We will work with researchers to coordinate vulnerability disclosure between our stakers, partners, and users to ensure successful mitigation of vulnerabilities. +If you identify vulnerabilities with _any_ nucypher code, please email security@nucypher.com with relevant information +to your findings. +We will work with researchers to coordinate vulnerability disclosure between our stakers, partners, and users to ensure +successful mitigation of vulnerabilities. -Throughout the reporting process, we expect researchers to honor an embargo period that may vary depending on the severity of the disclosure. +Throughout the reporting process, we expect researchers to honor an embargo period that may vary depending on the +severity of the disclosure. This ensures that we have the opportunity to fix any issues, identify further issues (if any), and inform our users. Sometimes vulnerabilities are of a more sensitive nature and require extra precautions. @@ -62,4 +50,5 @@ Email security@nucypher.com and we will coordinate a communication channel that A great place to begin your research is by working on our testnet. Please see our [documentation](https://docs.nucypher.com) to get started. We ask that you please respect testnet machines and their owners. -If you find a vulnerability that you suspect has given you access to a machine against the owner's permission, stop what you're doing and immediately email security@nucypher.com. +If you find a vulnerability that you suspect has given you access to a machine against the owner's permission, stop what +you're doing and immediately email security@nucypher.com.