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

Update readme - Closes #604 #612

Merged
merged 8 commits into from
Oct 1, 2018
Merged

Update readme - Closes #604 #612

merged 8 commits into from
Oct 1, 2018

Conversation

shuse2
Copy link
Contributor

@shuse2 shuse2 commented Sep 12, 2018

What was the problem?

Since v2.0 dynamically change the command list, readme needed to be updated.

How did I fix it?

Update the docs using autogeneration which oclif provides.

Review checklist

@shuse2 shuse2 self-assigned this Sep 12, 2018
@shuse2 shuse2 changed the base branch from development to 558-migrate_create_transaction_commands September 12, 2018 14:47
@shuse2 shuse2 force-pushed the 558-migrate_create_transaction_commands branch from 83b2bb2 to e80f72b Compare September 13, 2018 14:37
@shuse2 shuse2 force-pushed the 558-migrate_create_transaction_commands branch 2 times, most recently from 1deff4c to f82a696 Compare September 24, 2018 08:14
@shuse2 shuse2 changed the base branch from 558-migrate_create_transaction_commands to 2.0.0 September 25, 2018 14:51
### Something else went wrong. What should I do?

1. Make sure you’re on the network you intend to be on.
1. Exit Lisk Commander (if in interactive mode) and restart.
1. Remove the configuration file (`config.json`) located in your Lisk Commander configuration directory (`~/.lisk-commander` by default). When you restart Lisk Commander the default configuration will be recreated.
1. Remove the configuration file (`config.json`) located in your Lisk Commander configuration directory (`~/.lisk` by default). When you restart Lisk Commander the default configuration will be recreated.
Copy link
Contributor

Choose a reason for hiding this comment

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

Path to configuration should be ~/.lisk-commander instead of ~/.lisk.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@@ -9,7 +9,7 @@ Lisk Commander allows you to communicate with a remote or local node and carry o

## Prerequisites

Lisk Commander requires [Node.js](https://nodejs.org/) as the underlying engine for code execution. Node.js is supported on most operating systems. Follow the instructions for your operating system on the [Node.js downloads page](https://nodejs.org/en/download/). We currently require Node.js versions between 6.12 and 6.14 (inclusive). NPM is automatically installed along with Node.js.
Lisk Commander requires [Node.js](https://nodejs.org/) as the underlying engine for code execution. Node.js is supported on most operating systems. Follow the instructions for your operating system on the [Node.js downloads page](https://nodejs.org/en/download/). We currently require Node.js versions above 8.3. NPM is automatically installed along with Node.js.

Copy link
Contributor

Choose a reason for hiding this comment

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

"8.3 and above" or "8.3 (inclusive)"?

EXAMPLES
node:get
node:get --all
```
Copy link
Contributor

Choose a reason for hiding this comment

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

Add documentation and examples for --forging-status flag. Remove --all flag.

@shuse2 shuse2 removed the request for review from willclarktech October 1, 2018 12:51
@shuse2 shuse2 merged commit 9126ec1 into 2.0.0 Oct 1, 2018
@shuse2 shuse2 deleted the 604-update_readme branch October 1, 2018 16:00
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