Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Usage instructions could be clearer #3

Closed
purplecabbage opened this issue Jan 6, 2020 · 1 comment · Fixed by #4
Closed

Docs: Usage instructions could be clearer #3

purplecabbage opened this issue Jan 6, 2020 · 1 comment · Fixed by #4
Labels
documentation Improvements or additions to documentation

Comments

@purplecabbage
Copy link
Member

Current readme looks like this:

$ npm install -g @adobe/aio-cli-plugin-auth
$ aio COMMAND
running command...
$ aio (-v|--version|version)
@adobe/aio-cli-plugin-auth/1.0.4 darwin-x64 node-v10.15.3
$ aio --help [COMMAND]
USAGE
  $ aio COMMAND
...

We should probably be clearer that this is a plugin for the aio-cli and is auto installed when the aio-cli is.

Usage should maybe go straight to :

aio login ...
aio logout ...
...
@meryllblanchet meryllblanchet added the documentation Improvements or additions to documentation label Jan 7, 2020
@shazron
Copy link
Member

shazron commented Jan 15, 2020

I think the main cli will have all the documentation for all the plugins as well.
For that usage section, we can remove the generated <!-- usage --> section in the README.md if it's confusing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants