Skip to content
This repository has been archived by the owner on Apr 15, 2019. It is now read-only.

Update readme - Closes #541 #545

Merged
merged 3 commits into from
Jun 11, 2018
Merged

Update readme - Closes #541 #545

merged 3 commits into from
Jun 11, 2018

Conversation

shuse2
Copy link
Contributor

@shuse2 shuse2 commented Jun 11, 2018

What was the problem?

The version number and setting commands example were outdated.

Review checklist

@shuse2 shuse2 self-assigned this Jun 11, 2018
@shuse2 shuse2 requested a review from willclarktech June 11, 2018 09:24
README.md Outdated
| ----------------------------------------------------- | ----------------------------------------------------------- |
| <code>set json true&#124;false</code> | Sets default to JSON output (true) or text output (false). |
| <code>set pretty true&#124;false</code> | Sets default to formatted output when JSON output is used. |
| <code>set api.network main&#124;test&#124;beta</code> | Sets api target to the specified network. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sets API target

README.md Outdated
| <code>set json true&#124;false</code> | Sets default to JSON output (true) or text output (false). |
| <code>set pretty true&#124;false</code> | Sets default to formatted output when JSON output is used. |
| <code>set api.network main&#124;test&#124;beta</code> | Sets api target to the specified network. |
| <code>set api.nodes http://localhost:4000</code> | Override api.network and set specific nodes communicate to. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's give an example with more than one node.

README.md Outdated
| <code>set testnet true&#124;false</code> | Set default to testnet (true) or mainnet (false) |
| Command | Description |
| ----------------------------------------------------- | ----------------------------------------------------------- |
| <code>set json true&#124;false</code> | Sets default to JSON output (true) or text output (false). |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about set name?

Copy link
Contributor

@willclarktech willclarktech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One minor grammatical point.

README.md Outdated
| Command | Description |
| -------------------------------------------------------------------------- | ----------------------------------------------------------- |
| <code>set name lisk</code> | Sets name to be displayed. |
| <code>set delimiter lisk</code> | Sets delimiter in the interactive mode. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sets delimiter in interactive mode.

@shuse2 shuse2 merged commit 49ca918 into 1.0.0 Jun 11, 2018
@shuse2 shuse2 deleted the 541-update_readme branch June 11, 2018 16:48
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants