Publish Crates, Npm Package and Usage Docs

README.md

@@ -31,8 +31,103 @@
 
 ##
 
-This project will implement a pure rust crate for creating and manipulating IPLD graphs that encode WNFS.
-Its goal is to be as dependency-less as possible in order to be easily compiled to WebAssembly to be used in the browsers or other environments.
+This crate is a Rust implementation of the primitives for creating and manipulating IPLD graphs that encode WNFS.
+
+A goal of the project is to be easily compiled to WebAssembly to be used in the browsers or other environments.
+
+## Outline
+
+- [Usage](#usage)
+- [Building the Project](#building-the-project)
+- [Testing the Project](#testing-the-project)
+
+## Usage
+
+Creating a new public directory.
+
+```rust
+use wnfs::{PublicDirectory, Id};
+
+use async_std::main;
+use chrono::Utc;
+
+#[async_std::main]
+async fn main() {
+  let dir = PublicDirectory::new(Utc::now());
+  println!("id = {}", dir.get_id());
+}
+```
+
+The in-memory files and directories you create with `wnfs` will need to be sealed and stored somewhere. For that, a type that implements the BlockStore trait like [this one](https://github.com/WebNativeFileSystem/rs-wnfs/blob/8bb0fbb457051295f1ed4a4707dc230c04612658/crates/fs/common/blockstore.rs#L42-L62) can be used.
+
+```rust
+use wnfs::{MemoryBlockStore, PublicDirectory, OpResult, ipld::Cid};
+
+use async_std::main;
+use chrono::Utc;
+
+use std::rc::Rc;
+// ...
+```
+
+The WNFS API is immutable, therefore, we need to keep track of the updated root directory after every change.
+
+Each fs operation returns a possibly updated root directory that subsequent changes can be applied on.
+
+```rust
+// ...
+#[async_std::main]
+async fn main() {
+    let time = Utc::now();
+    let dir = Rc::new(PublicDirectory::new(time));
+    let store = MemoryBlockStore::default();
+
+    // Create a /pictures/cats directory.
+    let OpResult { root_dir, .. } = dir
+        .mkdir(&["pictures".into(), "cats".into()], time, &store)
+        .await
+        .unwrap();
+
+    // Get a sample CIDv1.
+    let cid = Cid::default();
+
+    // Add a file to /pictures/cats.
+    let OpResult { root_dir, .. } = root_dir
+        .write(
+            &["pictures".into(), "cats".into(), "tabby.png".into()],
+            cid,
+            time,
+            &store,
+        )
+        .await
+        .unwrap();
+
+    // Create and add a file to /pictures/dogs directory.
+    let OpResult { root_dir, .. } = root_dir
+        .write(
+            &["pictures".into(), "dogs".into(), "billie.jpeg".into()],
+            cid,
+            time,
+            &store,
+        )
+        .await
+        .unwrap();
+
+    // Delete /pictures/cats directory.
+    let OpResult { root_dir, .. } = root_dir
+        .rm(&["pictures".into(), "cats".into()], &store)
+        .await
+        .unwrap();
+
+    // List all files in /pictures directory.
+    let OpResult { result, .. } = root_dir
+        .ls(&["pictures".into()], &store)
+        .await
+        .unwrap();
+
+    println!("Files in /pictures: {:#?}", result);
+}
+```
 
 ## Building the Project
 
@@ -44,7 +139,7 @@ Its goal is to be as dependency-less as possible in order to be easily compiled
 
 - **The WebAssembly Toolchain**
 
-  If yous are interested in compiling the project for WebAssembly, you can follow the instructions below.
+  If you are interested in compiling the project for WebAssembly, you can follow the instructions below.
 
   <details>
     <summary>Read more</summary>
@@ -85,23 +180,23 @@ Its goal is to be as dependency-less as possible in order to be easily compiled
 
   </details>
 
-- **The _wnfs_ Helper Script**
+- **The _rs-wnfs_ Command**
 
-  If you are on a Unix platform, you can optionally install the `wnfs` script.
+  You can optionally set up the `rs-wnfs` script.
 
   <details>
     <summary>Read more</summary>
 
   - Install it using the following command:
 
     ```bash
-    sh script/wnfs.sh setup
+    sh script/rs-wnfs.sh setup
     ```
 
-  - This lets you run the `wnfs.sh` script with just the `wnfs` command.
+  - This lets you run the `rs-wnfs.sh` script as a command.
 
     ```bash
-    wnfs help
+    rs-wnfs help
     ```
 
   </details>
@@ -122,20 +217,28 @@ Its goal is to be as dependency-less as possible in order to be easily compiled
 
 - Build the project
 
+  Check [REQUIREMENTS](#requirements) on how to set up the `rs-wnfs` command.
+
+  ```bash
+  rs-wnfs build --all
+  ```
+
+- You can also build for specific crates
+
   ```bash
-  sh scripts/wnfs.sh build
+  rs-wnfs build --wasm
   ```
 
 ## Testing the Project
 
 - Run all tests
 
   ```bash
-  sh scripts/wnfs.sh test
+  rs-wnfs test --all
   ```
 
 - Show code coverage
 
   ```bash
-  sh scripts/wnfs.sh coverage
+  rs-wnfs coverage
   ```

crates/fs/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "wnfs"
-version = "0.1.1"
+version = "0.1.6"
 description = "WebNative filesystem core implementation"
 keywords = ["wnfs", "webnative", "ipfs", "decentralisation"]
 categories = [
@@ -9,10 +9,10 @@ categories = [
   "web-programming",
   "wasm",
 ]
-license-file = "../../LICENSE"
+license = "Apache-2.0"
 readme = "README.md"
 edition = "2021"
-repository = "https://github.com/fission-suite/rs-wnfs"
+repository = "https://github.com/WebNativeFileSystem/rs-wnfs/tree/main/crates/fs"
 homepage = "https://fission.codes"
 authors = ["The Fission Authors"]
 
@@ -29,7 +29,7 @@ async-recursion = "1.0.0"
 field_names = "0.2.0"
 futures = "0.3.21"
 async-stream = "0.3.3"
-
+futures-util = "0.3.21"
 
 [lib]
 path = "lib.rs"