Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

docs: update architecture overview and core architecture image, add more info to the readme #637

Merged
merged 1 commit into from
Dec 4, 2016
Merged

docs: update architecture overview and core architecture image, add more info to the readme #637

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 62 additions & 19 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.

Binary file removed graphs/arch-full.monopic
View file
Open in desktop
Binary file not shown.
46 changes: 0 additions & 46 deletions graphs/arch-full.txt
View file
Open in desktop

This file was deleted.

Binary file removed graphs/arch.monopic
View file
Open in desktop
Binary file not shown.
9 changes: 0 additions & 9 deletions graphs/arch.txt
View file
Open in desktop

This file was deleted.

Binary file added img/core.monopic
View file
Open in desktop
Binary file not shown.
Binary file added img/core.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 36 additions & 0 deletions img/core.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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│
└─────────┴─────────┘
Binary file added img/overview.monopic
View file
Open in desktop
Binary file not shown.
Binary file added img/overview.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 17 additions & 0 deletions img/overview.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 │
└────────────┘