chore(unixfs): README, license notes, set version to 0.0.1
This commit is contained in:
parent
b942b1a759
commit
740c5f1cd7
2
Cargo.lock
generated
2
Cargo.lock
generated
@ -1443,7 +1443,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "ipfs-unixfs"
|
||||
version = "0.1.0"
|
||||
version = "0.0.1"
|
||||
dependencies = [
|
||||
"cid",
|
||||
"either",
|
||||
|
@ -1,8 +1,9 @@
|
||||
[package]
|
||||
name = "ipfs-unixfs"
|
||||
version = "0.1.0"
|
||||
version = "0.0.1"
|
||||
authors = ["Joonas Koivunen <joonas@equilibrium.co>"]
|
||||
edition = "2018"
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||
[features]
|
||||
|
@ -1,12 +1,12 @@
|
||||
# ipfs-unixfs
|
||||
|
||||
Goals:
|
||||
## Goals
|
||||
|
||||
* blockstore API independent way to traverse the merkledag
|
||||
* the core read API does not deal with loading blocks
|
||||
* instead access to interesting `Cid`s is given
|
||||
|
||||
Status:
|
||||
## Status
|
||||
|
||||
* first iteration of file reader has been implemented
|
||||
* first iteration of resolving IpfsPath segments through directories has been
|
||||
@ -17,9 +17,13 @@ Status:
|
||||
* first iteration of `/get`-like tree walking implemented
|
||||
* creation and alteration of dags has not been implemented
|
||||
|
||||
Usage:
|
||||
## 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`
|
||||
|
||||
## License
|
||||
|
||||
MIT or APL2.
|
||||
|
Loading…
Reference in New Issue
Block a user