Update README.md #319
Open
Update README.md #319
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
README.md
Outdated
| @@ -1,6 +1,6 @@ | |||
| # zwallet - a CLI for Züs wallet | |||
|
|
|||
| `zwallet` is a command line interface (CLI) to demonstrate the wallet functionalities of Züs. | |||
| ZWallet CLI is a Go-based command-line tool for managing ZCN tokens on the Züs blockchain. It provides an interactive way to receive, send, store, stake, and exchange ZCN tokens, as well as fetch information about Züs components such as miners, sharders, and blobbers. | |||
There was a problem hiding this comment.
Missing: ZWallet CLI is also used to create and manage wallet
|
|
||
| For instance, the user can start with 10 data and 5 parity providers and select where they are located globally, and later decide to add a provider on-the-fly to increase resilience, performance, or switch to a lower cost provider. | ||
| For instance, the user can start with 10 data and 5 parity providers and select where they are located globally, and later decide to add a provider on-the-fly to increase resilience, and performance or switch to a lower-cost provider. |
There was a problem hiding this comment.
Lower-cost provider is fine but Low-cost provider is most commonly used phrase
README.md
Outdated
| | `--configDir` | Config directory | `~/.zcn` | | ||
| | `--network` | [Network file](#override-network) | `network.yaml` | | ||
| | `--silent` | Do not print detailed logs | `false` | | ||
| | `--h,--help` | Shows help/parameters for a particular command (./zwallet -h) will list all help commands. To know detail about a particular command like example 'send' use (./zwallet send --help ) | | |
There was a problem hiding this comment.
for --help command spacing is not correct
README.md
Outdated
| | `--silent` | Do not print detailed logs | `false` | | ||
| | `--h,--help` | Shows help/parameters for a particular command (./zwallet -h) will list all help commands. To know detail about a particular command like example 'send' use (./zwallet send --help ) | | | ||
| | `--config` | [Config file](https://github.com/0chain/zwalletcli/blob/staging/network/config.yaml) and [description](https://github.com/0chain/zwalletcli#zcnconfigyaml). Configuration file | `config.yaml` | | ||
| | `--configDir` | Configuration directory | `~/.zcn` | |
There was a problem hiding this comment.
incrase the parameter coplumn size so that commands can fit in and does not break line for commands
README.md
Outdated
|
|
||
| ```sh | ||
| ./zwallet faucet --methodName pour --input "new wallet" | ||
| ``` | ||
|
|
||
| #### Creating a second wallet with 'faucet' command |
There was a problem hiding this comment.
The output for this command shows that this command is finding if a wallet exists or not then its creating another wallet so its better to allign the command with the heading or change the heading to "Creating a second wallet with 'faucent' command " then its output should not show that the no wallet exists in the path because its task is to create the wallet not to find an existing wallet
README.md
Outdated
| @@ -667,7 +671,7 @@ To use a different wallet as sender, use `--wallet` global parameter. | |||
| | --------- | -------- | ----------------------------- | ------- | ---------------------- | | |||
| | `--hash` | Yes | Hash of transaction to verify | | valid transaction hash | | |||
|
|
|||
| Note: Not all `zwallet` commands (eg. `send`) prints the transaction hash created. To see more details printed including the hashes, use `--verbose` global parameter. | |||
| Note: Not all `zwallet` commands (e.g., `send`) prints the transaction hash created. To see more details printed, including the hashes, use `--verbose` global parameter. | |||
There was a problem hiding this comment.
(e.g., send) should be (e.g, send)
HassanAbbas7357
suggested changes
Nov 6, 2023
example outputs of each option of each command for most cases for better understanding.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A brief description of the changes in this PR:
Tasks to complete before merging PR:
Associated PRs (Link as appropriate):