docs: update architecture overview and core architecture image, add m…

…ore info to the readme
ipfs · Dec 4, 2016 · 9a69a12 · 9a69a12
1 parent 97a1520
commit 9a69a12
Show file tree

Hide file tree

Showing 11 changed files with 115 additions and 74 deletions.
diff --git a/README.md b/README.md
diff --git a/graphs/arch-full.monopic b/graphs/arch-full.monopic
diff --git a/graphs/arch-full.txt b/graphs/arch-full.txt
diff --git a/graphs/arch.monopic b/graphs/arch.monopic
diff --git a/graphs/arch.txt b/graphs/arch.txt
diff --git a/img/core.monopic b/img/core.monopic
diff --git a/img/core.png b/img/core.png
diff --git a/img/core.txt b/img/core.txt
@@ -0,0 +1,36 @@
+ ┌─────────────────────────────────────────────────────────────────────────────┐
+ │                                                                             │
+ │                                  IPFS Core                                  │
+ │                                                                             │
+ ├ ─ ─ ─ ─┌ ─ ─ ─ ─┌ ─ ─ ─ ─┌ ─ ─ ─ ─┌ ─ ─ ─ ─                        ┌ ─ ─ ─ ─│
+ │  Repo  │ Block  │Bitswap │  DAG   │ Files  │                         Swarm  │
+ │        │        │        │        │                                │        │
+ └────────┴────────┴────────┴────────┴────────┴────────────────────────────────┘
+      │       │         │       │      │                                  │     
+      │       │         │       │      ▼                                  │     
+      │       │         │       │ ┌──────────────────┐                    ▼     
+      │       │         │       │ │ipfs-unixfs-engine│   ┌─────────────────────┐
+      │       │         │       │ └──────┬───────────┤   │                     │
+      │       │         │       │      │ │ipfs-unixfs│   │       libp2p        │
+      │       │         │       │      │ └───────────┘   │                     │
+      │       │         │       ▼      ▼                 ├─────────────────────┤
+      │       │         │     ┌─────────────┬────────┐   │ libp2p-ipfs-nodejs  │
+      │       │         │     │ipfs-resolver│dag-pb  │   ├─────────────────────┤
+      │       │         │     └─────────────┼────────┤   │ libp2p-ipfs-browser │
+      │       │         ▼            │      │dag-cbor│   └─────────────────────┘
+      │       │┌────────────┐        │      ├────────┤                          
+      │       ││ipfs-bitswap│◀───────┤      │ethereum│                          
+      │       │└────────────┘        │      ├────────┤                          
+      │       │         │            │      │...     │                          
+      │       ▼         ▼            │      └────────┘                          
+      │ ┌───────────────────┐        │                                          
+      │ │ipfs-blocks-service│◀───────┘                                          
+      │ └───────────────────┘                                                   
+      │           │                                                             
+      ├───────────┘                                                             
+      ▼                                                                         
+ ┌─────────┬─────────┐                                                          
+ │         │   fs    │                                                          
+ │ipfs-repo├─────────┤                                                          
+ │         │IndexedDB│                                                          
+ └─────────┴─────────┘                                                          
diff --git a/img/overview.monopic b/img/overview.monopic
diff --git a/img/overview.png b/img/overview.png
diff --git a/img/overview.txt b/img/overview.txt
@@ -0,0 +1,17 @@
+
+                       offline mode - uses IPFS core directly                    
+                    ┌───────────────────────────────────────────┐                
+                    │                                           │                
+                    │                                           │                
+                    │ online mode - uses IPFS through http-api  │                
+   ┌────────────┐   │                  ┌────────────────────┐   │    ┌──────────┐
+   │            │   │ ┌ ─ ─ ─ ─ ─ ─    │                    │   │    │          │
+   │    CLI     │───┴──  ipfs-api  ├──▶│     HTTP-API       │───┴───▶│IPFS Core │
+   │            │     └ ─ ─ ─ ─ ─ ─    │                    │        │          │
+   └────────────┘                      └────────────────────┘        └──────────┘
+          △                                       △                        △     
+          ├───────────────────────────────────────┴────────────────────────┘     
+          │                                                                      
+   ┌────────────┐                                                                
+   │   Tests    │                                                                
+   └────────────┘