Add docs to README.md (#168)

* Add docs to README.md * Update README.md Co-authored-by: adlrocha <[email protected]> --------- Co-authored-by: adlrocha <[email protected]>
consensus-shipyard · Jul 31, 2023 · 192bb4e · 192bb4e
1 parent c222716
commit 192bb4e
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -17,6 +17,16 @@ The project accommodates the following main contracts
 - `SubnetActor.sol`: Reference implementation of an IPC subnet actor.
 - `SubnetRegistry.sol`: Registry contract for seamlessly deploying subnet actors.
 
+# Documentation
+
+## High-level Overview
+
+The original idea of IPC is presented in these [paper](https://research.protocol.ai/publications/hierarchical-consensus-a-horizontal-scaling-framework-for-blockchains/delarocha2022.pdf), [post](https://docs.filecoin.io/basics/interplanetary-consensus/overview/) and [video](https://www.youtube.com/watch?v=G7d5KNRZdp0). The protocol has evolved a lot since the original paper, so take it as a high-level description of the system. 
+
+## Specification
+
+The current specification draft is available [here](https://github.com/consensus-shipyard/IPC-design-reference-spec/blob/main/main.pdf).
+
 # Deploying IPC Solidity contracts
 Before deploying the contract, you'll need to configure the `RPC_URL` and `PRIVATE_KEY` environmental variables
 to point to your network provider and the private key of the address you want to use for the deployment, respectively.