README.md

Nest 🪺

A layer around the wnfs package that provides a FileSystem class, a root tree, mounts, transactions and some other essentials.

More info in the package readme.

Packages

• nest - The primary nest package.

Examples

• audio - Shows how to play audio from a file system using an <audio> element.
• demo - A simple demo of how the nest package is used.
• web3storage - An example app that shows how to store a WNFS on Web3Storage using the nest package.

Checkout examples

You can use Codesandbox https://githubbox.com/wnfs-wg/nest/tree/main/examples/demo and start hacking right away.

To clone it locally:

npx tiged wnfs-wg/nest/examples/demo demo
cd demo
pnpm install
pnpm dev

You can try any of the examples by replacing demo with the name of the example you want to try.

Contributing

Read contributing guidelines here.

License

This project is licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.