Merge pull request #198 from eqlabs/prepare_unixfs_release

Prepare initial ipfs-unixfs release

Cargo.lock

@@ -1443,7 +1443,7 @@ dependencies = [
 
 [[package]]
 name = "ipfs-unixfs"
-version = "0.1.0"
+version = "0.0.1"
 dependencies = [
  "cid",
  "either",
@@ -1453,7 +1453,6 @@ dependencies = [
  "multihash 0.10.1",
  "quick-protobuf",
  "sha2",
- "tar",
 ]
 
 [[package]]

unixfs/CHANGELOG.md

@@ -0,0 +1,8 @@
+# 0.0.1
+
+Initial release.
+
+* `ipfs_unixfs::walk::Walker` for walking directories, files and symlinks
+* `ipfs_unixfs::resolve` for resoving a single named link over directories
+  (plain or HAMT sharded)
+* `ipfs_unixfs::file::visit::FileVisit` lower level file visitor

unixfs/Cargo.toml

@@ -1,8 +1,12 @@
 [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"
+description = "UnixFs tree support"
+repository = "https://github.com/rs-ipfs/rust-ipfs"
+readme = "README.md"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 [features]
@@ -12,12 +16,10 @@ default = [ "filetime" ]
 quick-protobuf = "0.7.0"
 cid = "0.4.0"
 filetime = { version = "0.2.10", optional = true }
-either = ">=1.5.3"
+either = "1.5.3"
 
 [dev-dependencies]
 multibase = "0.8.0"
 multihash = "0.10.1"
 sha2 = "0.8.1"
 hex-literal = "0.2.1"
-# we don't need the xattr and we didn't actually need any filetime either
-tar = { version = "0.4.28", default-features = false }

unixfs/README.md

@@ -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.