Nucypher
/
nucypher
mirror of https://github.com/nucypher/nucypher.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
nucypher/README.md

125 lines
12 KiB
Markdown
Raw Normal View History

Categorical Table of Contents for NuCypher existing documentation port
2019-01-22 20:05:34 +00:00
NuCypher
========
Readme Updates, Include Whitepapers, Borrow language from Website
2019-01-23 19:29:30 +00:00
*A proxy re-encryption network to empower privacy in decentralized systems*
Futher title adjustments, blockquotes, interdocument linkage, guide enhancements
2019-01-24 00:46:48 +00:00
.. figure:: data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTAyNCIgaGVpZ2h0PSIxMDI0IiB2aWV3Qm94PSIwIDAgMTAyNCAxMDI0IiB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiPgo8dGl0bGU+RGVza3RvcCA0PC90aXRsZT4KPGRlc2M+Q3JlYXRlZCB1c2luZyBGaWdtYTwvZGVzYz4KPGcgaWQ9IkNhbnZhcyIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoLTM3NjggMzI5NCkiPgo8Y2xpcFBhdGggaWQ9ImNsaXAtMCIgY2xpcC1ydWxlPSJldmVub2RkIj4KPHBhdGggZD0iTSAzNzY4IC0zMjk0TCA0NzkyIC0zMjk0TCA0NzkyIC0yMjcwTCAzNzY4IC0yMjcwTCAzNzY4IC0zMjk0WiIgZmlsbD0iI0ZGRkZGRiIvPgo8L2NsaXBQYXRoPgo8ZyBpZD0iRGVza3RvcCA0IiBjbGlwLXBhdGg9InVybCgjY2xpcC0wKSI+CjxwYXRoIGQ9Ik0gMzc2OCAtMzI5NEwgNDc5MiAtMzI5NEwgNDc5MiAtMjI3MEwgMzc2OCAtMjI3MEwgMzc2OCAtMzI5NFoiIGZpbGw9IiNGRkZGRkYiLz4KPGcgaWQ9IndvcmRtYXJrIj4KPGcgaWQ9IlZlY3RvciI+Cjx1c2UgeGxpbms6aHJlZj0iI3BhdGgwX2ZpbGwiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDM5MDEgLTI2MjQuNjQpIiBmaWxsPSIjMUU2NUYzIi8+CjwvZz4KPGcgaWQ9IlZlY3RvciI+Cjx1c2UgeGxpbms6aHJlZj0iI3BhdGgxX2ZpbGwiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDQwMTYuMzQgLTI1OTAuMjMpIiBmaWxsPSIjMUU2NUYzIi8+CjwvZz4KPGcgaWQ9IlZlY3RvciI+Cjx1c2UgeGxpbms6aHJlZj0iI3BhdGgyX2ZpbGwiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDQxMDcuMjUgLTI2MjcpIiBmaWxsPSIjMTIxMTEyIi8+CjwvZz4KPGcgaWQ9IlZlY3RvciI+Cjx1c2UgeGxpbms6aHJlZj0iI3BhdGgzX2ZpbGwiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDQyMjQuMjkgLTI1OTAuMjUpIiBmaWxsPSIjMTIxMTEyIi8+CjwvZz4KPGcgaWQ9IlZlY3RvciI+Cjx1c2UgeGxpbms6aHJlZj0iI3BhdGg0X2ZpbGwiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDQzMjIuMzMgLTI1OTIuNTkpIiBmaWxsPSIjMTIxMTEyIi8+CjwvZz4KPGcgaWQ9IlZlY3RvciI+Cjx1c2UgeGxpbms6aHJlZj0iI3BhdGg1X2ZpbGwiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDQ0MjMuMzUgLTI2MjQuNjgpIiBmaWxsPSIjMTIxMTEyIi8+CjwvZz4KPGcgaWQ9IlZlY3RvciI+Cjx1c2UgeGxpbms6aHJlZj0iI3BhdGg2X2ZpbGwiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDQ1MTIuNTQgLTI1OTIuNjEpIiBmaWxsPSIjMTIxMTEyIi8+CjwvZz4KPGcgaWQ9IlZlY3RvciI+Cjx1c2UgeGxpbms6aHJlZj0iI3BhdGg3X2ZpbGwiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDQ2MTAuMzYgLTI1OTIuNTkpIiBmaWxsPSIjMTIxMTEyIi8+CjwvZz4KPC9nPgo8ZyBpZD0iY29pbm1hcmsiPgo8ZyBpZD0iVmVjdG9yIj4KPHVzZSB4bGluazpocmVmPSIjcGF0aDhfZmlsbCIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoMzk2NCAtMzEzNikiIGZpbGw9IiMxRTY1RjMiLz4KPC9nPgo8L2c+CjwvZz4KPC9nPgo8ZGVmcz4KPHBhdGggaWQ9InBhdGgwX2ZpbGwiIGQ9Ik0gLTEuOTI3MjRlLTA2IDEuNTQxNTNlLTA1TCAxOC41MDM1IDEuNTQxNTNlLTA1TCA3MS40ODc4IDgyLjMxNDdDIDczLjMzNDYgODUuMjAxNCA3NS4wMjEyIDg4LjE4NzYgNzYuNTM5OSA5MS4yNTk2TCA3Ni41Mzk5IDEuNTQxNTNlLTA1TCA5NC4wOTYxIDEuNTQxNTNlLTA1TCA5NC4wOTYxIDExOC4wNzNMIDc1LjUyOTUgMTE4LjA3M0wgMjIuNzEzNiAzNS43NTg4QyAyMC44NjY3IDMyLjg3MiAxOS4xODAxIDI5Ljg4NTkgMTcuNjYxNCAyNi44MTM4TCAxNy42NjE0IDExOC4wNzNMIC0xLjkyNzI0ZS0wNiAxMTguMDczTCAtMS45MjcyNGUtMDYgMS41NDE1M2UtMDVaIi8+CjxwYXRoIGlkPSJwYXRoMV9maWxsIiBkPSJNIDIuOTkxNDdlLTE0IC0zLjg1MzgxZS0wNkwgMTcuMjE5NCAtMy44NTM4MWUtMDZMIDE3LjIxOTQgNTAuMjYwMUMgMTcuMjE5NCA2My4yNDYxIDIzLjk1NTYgNzAuMTcwNiAzNS43NjUgNzAuMTcwNkMgNDguMDc5NSA3MC4xNzA2IDU3LjY5OTcgNTkuNjQ3MSA1Ny42OTk3IDQ1LjIwODlMIDU3LjY5OTcgLTMuODUzODFlLTA2TCA3NC45MTkgLTMuODUzODFlLTA2TCA3NC45MTkgODMuNjYxN0wgNTcuNjk5NyA4My42NjE3TCA1Ny42OTk3IDcwLjE0OTVDIDU1LjEwOTkgNzUuMDY3MSA1MS4xOTIgNzkuMTU5MyA0Ni4zOTE1IDgxLjk2MUMgNDEuNTkxIDg0Ljc2MjcgMzYuMTAwNSA4Ni4xNjEzIDMwLjU0NDQgODUuOTk3OUMgMTQuMTY3IDg1Ljk5NzkgMi45OTE0N2UtMTQgNzUuODc0MyAyLjk5MTQ3ZS0xNCA1My43OTYxTCAyLjk5MTQ3ZS0xNCAtMy44NTM4MWUtMDZaIi8+CjxwYXRoIGlkPSJwYXRoMl9maWxsIiBkPSJNIDExMC4xNTggOTEuNzY0N0MgOTcuODQzMSAxMTEuODIyIDg0LjAxMjkgMTIyLjc4OCA1OC41NDE3IDEyMi43ODhDIDI0Ljk2NiAxMjIuNzg4IDUuMTM5M2UtMDYgOTcuNTMxNiA1LjEzOTNlLTA2IDYxLjM5NEMgNS4xMzkzZS0wNiAyNS4yNTYzIDI2LjY1IC02LjQyMzAyZS0wNiA1OS4zODM3IC02LjQyMzAyZS0wNkMgODMuNTA3NyAtNi40MjMwMmUtMDYgMTAxLjcxNiAxMi42MjgyIDEwOS45MDUgMzAuNTE4MUwgOTUuNDAxMiA0MS4wNDE2QyA4Ni45ODEgMjQuNjg4MSA3NS4zMTkgMTYuNTg1IDU5LjEzMTEgMTYuNTg1QyAzNi44NTk2IDE2LjU4NSAxOC42Mjk4IDM1LjUyNzMgMTguNjI5OCA2MS40NTcxQyAxOC42Mjk4IDg3LjA5MjMgMzUuNjgwNyAxMDYuMzI5IDU4Ljk2MjcgMTA2LjMyOUMgNzQuODEzOCAxMDYuMzI5IDg3LjI5NjggOTguNzMxMyA5Ni4yNDMzIDgxLjg3MjdMIDExMC4xNTggOTEuNzY0N1oiLz4KPHBhdGggaWQ9InBhdGgzX2ZpbGwiIGQ9Ik0gMTIuNDgzIDEwMS43NDFDIDE0Ljg4MzIgMTAyLjc4OSAxNy40NjQgMTAzLjM2MSAyMC4wODIzIDEwMy40MjVDIDI0LjQ2MDggMTAzLjQyNSAyNy4xNTUzIDEwMi4wNzggMzAuMjA3NiA5NC40Nzk4TCAzNC4wODA5IDg0LjE4NzlMIC0xLjQxMzMxZS0wNSA3LjcwNzYzZS0wNkwgMTkuN
More detailed steps, ehnaced warnings, formatting, and innacuracy corrections for demos, guides.
2019-01-25 00:48:24 +00:00
:width: 60%
Categorical Table of Contents for NuCypher existing documentation port
2019-01-22 20:05:34 +00:00
More detailed steps, ehnaced warnings, formatting, and innacuracy corrections for demos, guides.
2019-01-25 00:48:24 +00:00
.. image:: https://img.shields.io/pypi/wheel/nucypher.svg
:target: https://pypi.org/project/nucypher/
.. image:: https://img.shields.io/pypi/pyversions/nucypher.svg
:target: https://pypi.org/project/nucypher/
Categorical Table of Contents for NuCypher existing documentation port
2019-01-22 20:05:34 +00:00
Readme Updates, Include Whitepapers, Borrow language from Website
2019-01-23 19:29:30 +00:00
.. image:: https://coveralls.io/repos/github/nucypher/nucypher/badge.svg?branch=master
:target: https://coveralls.io/github/nucypher/nucypher?branch=master
More detailed steps, ehnaced warnings, formatting, and innacuracy corrections for demos, guides.
2019-01-25 00:48:24 +00:00
.. image:: https://circleci.com/gh/nucypher/nucypher/tree/master.svg?style=svg
:target: https://circleci.com/gh/nucypher/nucypher/tree/master
Readme Updates, Include Whitepapers, Borrow language from Website
2019-01-23 19:29:30 +00:00
Futher title adjustments, blockquotes, interdocument linkage, guide enhancements
2019-01-24 00:46:48 +00:00
- GitHub https://www.gihub.com/nucypher/nucypher
- Documentation https://nucypher.readthedocs.io/en/latest/
- Website https://www.nucypher.com/
More detailed steps, ehnaced warnings, formatting, and innacuracy corrections for demos, guides.
2019-01-25 00:48:24 +00:00
Whitepapers
-----------
Readme Updates, Include Whitepapers, Borrow language from Website
2019-01-23 19:29:30 +00:00
More detailed steps, ehnaced warnings, formatting, and innacuracy corrections for demos, guides.
2019-01-25 00:48:24 +00:00
**Network**
Readme Updates, Include Whitepapers, Borrow language from Website
2019-01-23 19:29:30 +00:00
Respond to RFCs on PR #682
2019-01-25 17:46:42 +00:00
https://github.com/nucypher/whitepaper/blob/master/whitepaper.pdf
Readme Updates, Include Whitepapers, Borrow language from Website
2019-01-23 19:29:30 +00:00
More detailed steps, ehnaced warnings, formatting, and innacuracy corrections for demos, guides.
2019-01-25 00:48:24 +00:00
*"NuCypher - A proxy re-encryption network to empower privacy in decentralized systems"*
*by Michael Egorov, David Nuñez, and MacLane Wilkison - NuCypher*
Readme Updates, Include Whitepapers, Borrow language from Website
2019-01-23 19:29:30 +00:00
More detailed steps, ehnaced warnings, formatting, and innacuracy corrections for demos, guides.
2019-01-25 00:48:24 +00:00
**Economics**
Readme Updates, Include Whitepapers, Borrow language from Website
2019-01-23 19:29:30 +00:00
Respond to RFCs on PR #682
2019-01-25 17:46:42 +00:00
https://github.com/nucypher/mining-paper/blob/master/mining-paper.pdf
Readme Updates, Include Whitepapers, Borrow language from Website
2019-01-23 19:29:30 +00:00
More detailed steps, ehnaced warnings, formatting, and innacuracy corrections for demos, guides.
2019-01-25 00:48:24 +00:00
*"NuCypher - Mining & Staking Economics"*
*by Michael Egorov, MacLane Wilkison - NuCypher*
Readme Updates, Include Whitepapers, Borrow language from Website
2019-01-23 19:29:30 +00:00
More detailed steps, ehnaced warnings, formatting, and innacuracy corrections for demos, guides.
2019-01-25 00:48:24 +00:00
**Cryptography**
Readme Updates, Include Whitepapers, Borrow language from Website
2019-01-23 19:29:30 +00:00
More detailed steps, ehnaced warnings, formatting, and innacuracy corrections for demos, guides.
2019-01-25 00:48:24 +00:00
https://github.com/nucypher/umbral-doc/blob/master/umbral-doc.pdf
Readme Updates, Include Whitepapers, Borrow language from Website
2019-01-23 19:29:30 +00:00
More detailed steps, ehnaced warnings, formatting, and innacuracy corrections for demos, guides.
2019-01-25 00:48:24 +00:00
*"Umbral A Threshold Proxy Re-Encryption Scheme"*
*by David Nuñez*
Readme Updates, Include Whitepapers, Borrow language from Website
2019-01-23 19:29:30 +00:00
More detailed steps, ehnaced warnings, formatting, and innacuracy corrections for demos, guides.
2019-01-25 00:48:24 +00:00
.. warning::
Readme Updates, Include Whitepapers, Borrow language from Website
2019-01-23 19:29:30 +00:00
More detailed steps, ehnaced warnings, formatting, and innacuracy corrections for demos, guides.
2019-01-25 00:48:24 +00:00
NuCypher is currently in the *Alpha* development stage and is **not** intended for use production.
Readme Updates, Include Whitepapers, Borrow language from Website
2019-01-23 19:29:30 +00:00
Categorical Table of Contents for NuCypher existing documentation port
2019-01-22 20:05:34 +00:00
.. toctree::
:maxdepth: 2
Readme Updates, Include Whitepapers, Borrow language from Website
2019-01-23 19:29:30 +00:00
Architecture
------------
Categorical Table of Contents for NuCypher existing documentation port
2019-01-22 20:05:34 +00:00
.. toctree::
:maxdepth: 1
architecture/contracts
Installation Guide, General documentation cleanup, grammar corrections, structure, expansion of existing documentation port
2019-01-23 05:58:41 +00:00
architecture/upgradeable_proxy_contracts
Categorical Table of Contents for NuCypher existing documentation port
2019-01-22 20:05:34 +00:00
Guides
------
.. toctree::
:maxdepth: 2
guides/quickstart
More detailed steps, ehnaced warnings, formatting, and innacuracy corrections for demos, guides.
2019-01-25 00:48:24 +00:00
guides/ursula_configuration_guide
Categorical Table of Contents for NuCypher existing documentation port
2019-01-22 20:05:34 +00:00
guides/federated_testnet_guide
guides/installation_guide
Readme Updates, Include Whitepapers, Borrow language from Website
2019-01-23 19:29:30 +00:00
guides/contribution_guide
Categorical Table of Contents for NuCypher existing documentation port
2019-01-22 20:05:34 +00:00
Demos
-----
.. toctree::
:maxdepth: 2
demos/local_fleet_demo
demos/finnegans_wake_demo
demos/heartbeat_demo
Readme Updates, Include Whitepapers, Borrow language from Website
2019-01-23 19:29:30 +00:00
API
---
.. toctree::
:maxdepth: 2
api/characters
api/config
api/crypto
api/keyring
api/keystore
api/network
api/policy
Categorical Table of Contents for NuCypher existing documentation port
2019-01-22 20:05:34 +00:00
Release Notes
-------------
.. toctree::
:maxdepth: 1
release_notes/genesis_release
Readme Updates, Include Whitepapers, Borrow language from Website
2019-01-23 19:29:30 +00:00
Indices and Tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`