Skip to content
This repository has been archived by the owner on Oct 23, 2022. It is now read-only.

Commit

Permalink
chore: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Joonas Koivunen committed Aug 14, 2020
1 parent 2a68d04 commit b495c57
Showing 1 changed file with 4 additions and 14 deletions.
18 changes: 4 additions & 14 deletions unixfs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,11 @@

## Status

* first iteration of file reader has been implemented
* first iteration of resolving IpfsPath segments through directories has been
implemented
* as the HAMTShard structure is not fully understood, all buckets are
searched, however the API is expected to remain the same even if more
efficient lookup is implemented
* first iteration of `/get`-like tree walking implemented
* creation and alteration of dags has not been implemented
* unfiltered walking of known unixfs trees
* creation of balanced file trees
* creation of non HAMT-sharded directory trees

## Usage

* The main entry point to walking anything unixfs should be `ipfs_unixfs::walk::Walker`
* The main entry point to resolving links under dag-pb or unixfs should be `ipfs_unixfs::resolve`
* There is a `ipfs_unixfs::file::visit::FileVisit` utility but it should be
considered superceded by `ipfs_unixfs::walk::Walker`
See the docs at https://docs.rs/ipfs-unixfs.

## License

Expand Down

0 comments on commit b495c57

Please sign in to comment.