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(readme): add command-line options, cargo worskpace packages, installation instructions #105

Merged
merged 11 commits into from
Dec 2, 2020

Conversation

lrlna
Copy link
Member

@lrlna lrlna commented Dec 2, 2020

Description

This PR adds a few updates to the main README.md, inlcuding:

  • a print out of current rover --help to outline available command-line options
  • a list + appropriate description of each cargo workspaces packages
  • a brief mention on downloading and installing the binary
  • an update to rover-cli instead of apollo-cli

Copy link
Contributor

@EverlastingBugstopper EverlastingBugstopper left a comment

Choose a reason for hiding this comment

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

some tiny nits here - thanks so much for taking the time to update the README as it is sorely out of date!

I've suggested renaming instances of rover to Rover, as we've made the decision to stylize as "Rover" instead of rover unless we're specifically in the context of running the CLI as a command.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
lrlna and others added 9 commits December 2, 2020 17:23
Co-authored-by: Avery Harnish <[email protected]>
Co-authored-by: Avery Harnish <[email protected]>
Co-authored-by: Avery Harnish <[email protected]>
Co-authored-by: Avery Harnish <[email protected]>
Co-authored-by: Avery Harnish <[email protected]>
Co-authored-by: Avery Harnish <[email protected]>
Co-authored-by: Avery Harnish <[email protected]>
Co-authored-by: Avery Harnish <[email protected]>
Copy link
Contributor

@EverlastingBugstopper EverlastingBugstopper left a comment

Choose a reason for hiding this comment

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

thanks!

@EverlastingBugstopper EverlastingBugstopper merged commit 036eedd into main Dec 2, 2020
@EverlastingBugstopper EverlastingBugstopper deleted the docs-cli-options branch December 2, 2020 19:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants