diff --git a/README.md b/README.md index ca4dbf08..3945fde0 100644 --- a/README.md +++ b/README.md @@ -103,19 +103,71 @@ Review the cost, confirm, and the command returns your new Stamp ID. You can the ![Swarm CLI Feed Upload Command](./docs/feed-upload.gif) -## Upload a file with ACT +## Access Control Trie (ACT) + +You can use ACT related commands to manage access control for your content. To use and manage ACT, you need to use the `access` commands. + +### Initialize ACT +```sh +swarm-cli access init --stamp --list-name +``` + +### Grant access to a certain grantee + +```sh +swarm-cli access grant --list-name --grantee +``` + +### Revoke access from a certain grantee + +```sh +swarm-cli revoke grant --list-name --grantee +``` + +### Show list of grantee lists + +```sh +swarm-cli access list +``` + +### Show grantees in a certain grantee list + +```sh +swarm-cli access show --list-name +``` + +### Get the list of events for a certain grantee list + +```sh +swarm-cli access history --list-name +``` + +### Upload a file with ACT + +```sh +swarm-cli upload --share-with +``` + +##### [DEPRECATED] ```sh swarm-cli upload --act --stamp ``` -## Download a file with ACT +### Download a file with ACT + +`token` constructed from the owners public key and the history address + +```sh +swarm-cli download --access +``` +##### [DEPRECATED] ```sh swarm-cli download --act --act-history-address --act-publisher ``` -## Create a grantees list +### Create a grantees list [DEPRECATED] ```sh swarm-cli grantee create grantees.json --stamp @@ -132,13 +184,13 @@ swarm-cli grantee create grantees.json --stamp } ``` -## Get a grantees list +### Get a grantees list [DEPRECATED] ```sh swarm-cli grantee get ``` -## Patch a grantees list +### Patch a grantees list [DEPRECATED] ```sh swarm-cli grantee patch grantees-patch.json \