Skip to content

Commit

Permalink
docs(readme): adding example CLI cmds for Folders sync and changes st…
Browse files Browse the repository at this point in the history
…atus check
  • Loading branch information
bochaco committed Mar 5, 2024
1 parent 7693e67 commit 653f4d4
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ cargo run --bin safe --features local-discovery -- files download

### Folders

The folders storage capability can be demonstrated by uploading folders to the local network, then retrieving them.
The folders storage capability can be demonstrated by uploading folders to the local network, making changes and syncing them with the stored version on the network, as well as downloading the entire folders hierarchy onto a local directory.

Upload a directory:
```bash
Expand All @@ -115,6 +115,16 @@ Now download the folders, optionally providing a target directory name:
cargo run --bin safe --features local-discovery -- folders download <address> [dir name]
```

If any changes are now made to files or directories within this folder, before trying to push those changes to the network we can check the changes that has been made locally:
```bash
cargo run --bin safe --features local-discovery -- folders status [dir-path]
```

We can both push local changes made to files and directories to the network, as well as pull any changes that have been made to the version stored on the network since last time we synced with it:
```bash
cargo run --bin safe --features local-discovery -- folders sync [dir-path]
```

### Token Transfers

Use your local wallet to demonstrate sending tokens and receiving transfers.
Expand Down

0 comments on commit 653f4d4

Please sign in to comment.