Skip to content

Commit

Permalink
docs: add system diagram (#93)
Browse files Browse the repository at this point in the history
Closes #91
  • Loading branch information
achingbrain authored Apr 17, 2023
1 parent 6e37d9f commit c4f402c
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
- [πŸ₯… Purpose and goals](#-purpose-and-goals)
- [πŸƒβ€β™€οΈ Getting Started](#️-getting-started)
- [πŸ“’ API Docs](#-api-docs)
- [πŸ“ System diagram](#-system-diagram)
- [🏭 Code Structure](#-code-structure)
- [πŸ“£ Project status](#-project-status)
- [πŸ›£οΈ Roadmap](#️-roadmap)
Expand All @@ -39,6 +40,34 @@ Check out the [Helia examples repo](https://github.com/ipfs-examples/helia-examp

- https://ipfs.github.io/helia

## πŸ“ System diagram

```mermaid
graph TD;
User["User or application"]-->IPNS["@helia/ipns"];
User-->UnixFS["@helia/unixfs"];
User-->Libp2p;
User-->Datastore;
User-->Blockstore;
UnixFS-->Blockstore;
IPNS-->Datastore;
subgraph helia [Helia]
Datastore
Blockstore-->Bitswap;
Libp2p-->DHT;
Libp2p-->PubSub;
Libp2p-->IPNI;
Libp2p-->Reframe;
end
Blockstore-->BlockStorage["File system/IDB/S3/etc"]
Datastore-->DataStorage["Level/S3/IDB/etc"]
Bitswap-->Network;
DHT-->Network;
PubSub-->Network;
IPNI-->Network;
Reframe-->Network;
```

## 🏭 Code Structure
Helia embraces a modular approach and encourages users to bring their own implementations of interfacing libraries to suit their needs. Helia also ships supplemental libraries and tools including:

Expand Down

0 comments on commit c4f402c

Please sign in to comment.