diff --git a/README.md b/README.md index 80acaf9..0e70d93 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,22 @@ # ICO contracts ## Neumark contract structure + +### ICBM Contracts Diagram +![ICBM](./doc/icbmcontracts.png) + +### Snapshot Token Extensions Please read [here](/contracts/SnapshotToken/README.md). -## Neumark issuance algorithm. -Please read on the issuance curve in our [whitepaper](https://neufund.org/whitepaper) +### Neumark issuance algorithm. +Please read on the issuance curve in our [whitepaper](https://neufund.org/whitepaper), you may also refer to curve models in [doc](/doc). + +### Smart Contract and Legal Contract Parity +Mechanism is explained in source code [here](/contracts/Agreement.sol) and on diagram below. +![LEGALPARITY](./doc/agreementparity.png) +You may also check fork arbitrage mechanism [here](/contracts/EthereumForkArbiter.sol). ## Running locally ``` diff --git a/doc/agreementparity.png b/doc/agreementparity.png new file mode 100644 index 0000000..6f1d5a3 Binary files /dev/null and b/doc/agreementparity.png differ diff --git a/doc/icbmcontracts.png b/doc/icbmcontracts.png new file mode 100644 index 0000000..7a8a19c Binary files /dev/null and b/doc/icbmcontracts.png differ