Skip to content

Commit

Permalink
Readme: typo, grammar and semantic fixes (#47)
Browse files Browse the repository at this point in the history
* readme: typo, grammar and semantic fixes

It is past midnight, so I might have gotten the "reasonable" wrong.

* Update README.md

Co-authored-by: Gabor Greif <[email protected]>

* Update README.md

Co-authored-by: Christian Müller <[email protected]>
  • Loading branch information
ggreif and chmllr authored Sep 22, 2021
1 parent 6bcc82e commit f1672a7
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ To display the signed message in human-readable form:

quill send --dry-run <path-to-file>

`quill` could be used on an online computer to send any signed transactions:
`quill` could be used on an online computer to send any signed transaction:

quill send <path-to-file>

Expand All @@ -35,8 +35,6 @@ Managing the neuron:

quill --pem-file <path> neuron-manage <neuron-id> [OPERATIONS]

Currently supported operations are: `--start-dissolving`, `--stop-dissolving`, `--disburse`, `--add-hot-key`, `--remove-hot-key`, `--spawn`, `--split`.

All of the commands above will generate signed messages, which can be sent on the online machine using the `send` command from above.

## Download
Expand All @@ -58,11 +56,11 @@ After this, find the binary at `target/release/quill`.

`quill` is a very critical link in the workflow of the management of valuable assets.
`quill`'s code must stay clean, simple, readable and leave no room for ambiguities, so that it can be reviewed and audited by anyone.
Hence, if you would like to propose a change, please adhere to the following principals:
Hence, if you would like to propose a change, please adhere to the following principles:

1. Be concise and only add functional code.
2. Optimize for correctness, then for readability.
3. Avoid adding dependencies at all costs unless it's completely unreasonable.
3. Avoid adding dependencies at all costs unless it's completely unreasonable to do so.
4. Every new feature (+ a test) is proposed only after it was tested on real wallets.
5. Increment the last digit of the crate version whenever the functionality scope changes.

Expand Down

0 comments on commit f1672a7

Please sign in to comment.