Skip to content

Commit

Permalink
feat(docs): ✨ Mapping unixFS and IPNS packages
Browse files Browse the repository at this point in the history
  • Loading branch information
whizzzkid committed Apr 4, 2023
1 parent b48dd04 commit 1ecff11
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion MANIFESTO.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ The core of Helia will be very focused on use as a library: just [js-libp2p], a

A "get you started" bundle with some common components will be provided but users are very much encouraged to roll their own version of Helia to suit their use case.

> **Note**
>
> An implementation of IPNS compatible with helia can be installed from npm [`@helia/ipns`](https://github.com/ipfs/helia-ipns)
## BYO Filesystem

The default filesystem for IPFS is [UnixFS](https://github.com/ipfs/specs/blob/main/UNIXFS.md), but UnixFS has several limitations. Support for some common Unix file attributes such as mode (permission bits) and `mtime` landed in UnixFSv1.5, but this has yet to make it to [kubo].
Expand All @@ -35,6 +39,10 @@ Several features are still missing from 1.5, such as arbitrary metadata (extende

That these missing features are being implemented by other filesystems is incredibly exciting and will unlock new use cases that are not possible today, so Helia will not bless any one filesystem as the One True Implementation, instead it will present an abstraction of posix filesystem operations (`ls`, `cat`, etc) as an API but the underlying filesystem(s) will be configurable.

> **Note**
>
> An implementation of unixFS compatible with helia can be installed from npm [`@helia/unixfs`](https://github.com/ipfs/helia-unixfs).
## JavaScript first

In the beginning there were Node.js [streams](https://nodejs.org/api/stream.html#readable-streams). Then there were [pull streams](https://www.npmjs.com/package/pull-stream). And finally, browsers have [native streams too](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream).
Expand Down Expand Up @@ -71,4 +79,4 @@ It will use [js-libp2p] and [js-bitswap] to ensure compatibility with existing I
[js-libp2p]: https://github.com/libp2p/js-libp2p
[js-bitswap]: https://github.com/ipfs/js-ipfs-bitswap
[blockstore]: https://github.com/ipfs/js-ipfs-interfaces/tree/master/packages/interface-blockstore
[kubo]: https://github.com/ipfs/kubo
[kubo]: https://github.com/ipfs/kubo

0 comments on commit 1ecff11

Please sign in to comment.