diff --git a/docs/client-cli.md b/docs/client-cli.md index 92dd8969..f1f9ba56 100644 --- a/docs/client-cli.md +++ b/docs/client-cli.md @@ -14,4 +14,4 @@ Storing and reading blobs from Walrus can be achieved through the following comm CONFIG=working_dir/client_config.yaml # adjust for your configuration file walrus -c $CONFIG store # store a file walrus -c $CONFIG read # read a blob -``` \ No newline at end of file +``` diff --git a/docs/interacting.md b/docs/interacting.md index 652c5220..924ee9b3 100644 --- a/docs/interacting.md +++ b/docs/interacting.md @@ -1,6 +1,7 @@ # Interacting with Walrus We provide 3 ways to interact directly with the Walrus storage system: + - Through the walrus [client command line interface (CLI)](client-cli.md). - Through a [JSON API](json-api.md) of the walrus CLI. - Through an [HTTP API](web-api.md) exposed by the walrus client daemon. diff --git a/docs/json-api.md b/docs/json-api.md index 8be24598..9d78d0dd 100644 --- a/docs/json-api.md +++ b/docs/json-api.md @@ -1,8 +1,8 @@ # JSON mode All Walrus client commands (except, currently, the `info` command) are available in JSON mode. -In this mode, all the command line flags of the original CLI command can be specified in JSON format. -The JSON mode therefore simplifies programmatic access to the CLI. +In this mode, all the command line flags of the original CLI command can be specified in JSON +format. The JSON mode therefore simplifies programmatic access to the CLI. For example, to store a blob, run: diff --git a/docs/web-api.md b/docs/web-api.md index c1b0385d..f3314d76 100644 --- a/docs/web-api.md +++ b/docs/web-api.md @@ -38,4 +38,4 @@ curl "http://$ADDRESS/v1/" # read a blob from Walrus (with aggrega Modern browsers will attempt to sniff the content type for such resources, and will generally do a good job of inferring content types for media. However, the aggregator on purpose prevents such -sniffing from inferring dangerous executable types such as javascript or style sheet types. \ No newline at end of file +sniffing from inferring dangerous executable types such as javascript or style sheet types.