docs: update README to enhance clarity and add command details

[rmenner]

Alaska Airlines Pull Request

This pull request updates the README.md to provide a more comprehensive and user-friendly overview of the Auro CLI. The new documentation includes badges, installation instructions, a clear description of the CLI's purpose, and a detailed breakdown of all commands and their options.

Documentation improvements:

• Added status, NPM, and license badges to the top of the README.md for quick reference.
• Rewrote the introduction to clearly state the CLI's purpose and usage scenarios.
• Added installation and usage instructions, including both npm install and npx options.

Command reference and options:

• Provided a categorized, at-a-glance table of all CLI commands, grouped by development, repo maintenance, and release pipeline tasks.
• Added detailed descriptions and option lists for each command, making it easier for users to understand available features and how to use them.
• Included important usage notes and warnings (e.g., about destructive changes in auro sync).

Checklist:

• My update follows the CONTRIBUTING guidelines of this project
• I have performed a self-review of my own update

By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Pull Requests will be evaluated by their quality of update and whether it is consistent with the goals and values of this project. Any submission is to be considered a conversation between the submitter and the maintainers of this project and may require changes to your submission.

Thank you for your submission!

-- Auro Design System Team

Summary by Sourcery

Revise the README to provide a clearer, user-focused overview of the Auro CLI and its capabilities.

Documentation:

• Add badges, installation instructions, and npx usage guidance to the README.
• Document all CLI commands with categorized at-a-glance tables and detailed option references, including development, repo maintenance, and release pipeline tasks.
• Highlight important usage notes and warnings for potentially destructive operations such as auro sync.

[sourcery-ai]

Reviewer's Guide

README.md documentation for the Auro CLI was significantly expanded and restructured to add badges, installation guidance, and a full, categorized command reference with options and usage notes.

File-Level Changes

Change	Details	Files
Restructured the README introduction to clearly describe the Auro CLI purpose and usage at a glance.	Replaced the original one-line description with a fuller sentence explaining key capabilities (dev server, repo sync, builds, release pipeline). Added a note about the published package name to clarify how the CLI is distributed.	README.md
Added installation and quick-run instructions for the CLI.	Introduced an explicit Install section with npm install instructions. Documented npx-based usage for running the CLI without installing globally.	README.md
Introduced a categorized commands overview for development, repo maintenance, and release pipeline tasks.	Replaced the old generic table of contents and minimal dev command section with a new Commands section. Added an at-a-glance commands table grouped into Development, Repo maintenance, and Release pipeline categories, each with short descriptions.	README.md
Documented detailed options for each CLI subcommand and expanded usage notes.	Added per-command reference sections for dev, build, docs, test, sync, migrate, agent, ado, rc-workflow, pr-release, and check-commits. Listed flags and options for each command, including defaults and behaviors. Included warnings and operational guidance for destructive actions such as auro sync and notes about CI-oriented commands.	README.md
Added project status and metadata badges to make the README more informative at the top.	Inserted build status, npm version, and license badges under the main title. Linked badges to GitHub Actions, npm package, and license documentation.	README.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[github-actions]

🚀 PR Release Published! @aurodesignsystem-dev/auro-cli@0.0.0-pr310.0 View on npmjs.com