summaryrefslogtreecommitdiff
path: root/index.rst
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2014-11-20 09:23:59 +0100
committerChristian Grothoff <christian@grothoff.org>2014-11-20 09:23:59 +0100
commit3d108294a1f4a5e1a842f30921e56054a69fecce (patch)
tree2abfd6284078bd2bd91ea86bd146c6bee8007c12 /index.rst
downloaddocs-3d108294a1f4a5e1a842f30921e56054a69fecce.tar.gz
docs-3d108294a1f4a5e1a842f30921e56054a69fecce.tar.bz2
docs-3d108294a1f4a5e1a842f30921e56054a69fecce.zip
initial import of sphinx documentation
Diffstat (limited to 'index.rst')
-rw-r--r--index.rst54
1 files changed, 54 insertions, 0 deletions
diff --git a/index.rst b/index.rst
new file mode 100644
index 00000000..55b1dcb3
--- /dev/null
+++ b/index.rst
@@ -0,0 +1,54 @@
+Welcome to Neuro's documentation!
+=================================
+
+We are building an anonymous, taxable payment system using modern
+cryptography. Customers will use traditional money transfers to send
+money to a digital Mint and in return receive (anonymized) digital
+cash. Customers can use this digital cash to anonymously pay
+Merchants. Merchants can redeem the digital cash for traditional
+money at the digital Mint. As Merchants are not anonymous, they can
+be taxed, enabling income or sales taxes to be withheld by the state
+while providing anonymity for Customers.
+
+Cryptography is used to ensure that none of the participants can
+defraud the others without being detected immediately; however, in
+practice a fradulent Mint might go bankrupt instead of paying the
+Merchants and thus the Mint will need to be audited regularly like any
+other banking institution.
+
+The system will be based on free software and open protocols.
+In this document, we describe the REST-based API of the Mint,
+which is at the heart of the system.
+
+
+Contents
+========
+
+Protocol Specification:
+
+.. toctree::
+ :maxdepth: 2
+
+ api-mint
+ api-merchant
+
+Implementation:
+
+.. toctree::
+ :maxdepth: 2
+
+ impl-mint
+
+Supported Wire Transfer Formats:
+
+.. toctree::
+ :maxdepth: 2
+
+ wireformats
+
+
+Indices and tables
+==================
+
+* :ref:`search`
+