Making README shorter #124
Merged
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
anagoessens
reviewed
Mar 30, 2022
| passing the `--verbose` (or `-v`) flag to get more information about what the CLI is | ||
| doing. We also support stacking verbosity up to three levels for debug logs: `-vv` and `-vvv`. | ||
| If you are getting started with the tool we recommend enabling informational logs by | ||
| passing the `--verbose` (or `-v`). | ||
|
|
||
| ## Common examples |
There was a problem hiding this comment.
Not too sure if the common example should be included in the README.md
There was a problem hiding this comment.
i think it is a natural flow for new users after getting set up which is nice. Ideally we'd send them to the docs that'll be more comprehensive after that. In short, I think it'd be nice to keep for now, then possibly link out to docs and shorten or remove in future. WDYT?
|
|
||
| The `--toolbox` flag makes sure the invite has an alias as Toolbox, sets auto accept to true and sets the toolbox as admin for the invite. | ||
|
|
||
| ### Create an invitation for the toolbox |
|
I'm going to go ahead and merge this for now @blu3beri @anagoessens happy to take follow up requests for changes if you feel strongly about it! |
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.
Preview: https://github.com/animo/aries-cli/tree/Making-README-shorter