From b495c57a1f6403a4ff89fed0defe13e9468a427c Mon Sep 17 00:00:00 2001 From: Joonas Koivunen Date: Fri, 14 Aug 2020 15:47:20 +0300 Subject: [PATCH] chore: update README.md --- unixfs/README.md | 18 ++++-------------- 1 file changed, 4 insertions(+), 14 deletions(-) diff --git a/unixfs/README.md b/unixfs/README.md index d214b968..bef64336 100644 --- a/unixfs/README.md +++ b/unixfs/README.md @@ -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