Docs: Improve README documentation for workspace support

[Sewer56]

Summary

The README had no explicit documentation for cargo workspace support despite the action fully supporting it via the packages input. This PR adds dedicated documentation and cleans up existing content.

Changes

• Add Testing Specific Packages example section explaining the packages input (--all vs -p)
• Clarify rust-project-path as a directory path (not a file) with guidance for single crates and workspaces
• Update action.yml input description to match
• Shorten packages description in the inputs table
• Rename example sections to be more approachable (Testing Multiple Targets instead of Multi-Platform Matrix)
• Bump actions/checkout to v6 in examples
• Remove redundant codecov-token from examples where it's not the focus
• Replace em-dashes with regular dashes throughout

Files Changed

• README.MD - documentation improvements
• action.yml - updated rust-project-path description

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 76586b28-e8ad-4848-b8df-417a81075b74

📥 Commits

Reviewing files that changed from the base of the PR and between 7e492e1 and 4280cf3.

📒 Files selected for processing (2)

• README.MD
• action.yml

---

Walkthrough

The pull request updates documentation and action configuration to clarify workspace support. The README is expanded to describe full cargo workspace capabilities, including how to test all packages or a specified subset, and reorganizes example workflows with additional test scenarios. The action.yml file refines the rust-project-path input description to explicitly denote it as a directory containing Cargo.toml at the crate or workspace root, replacing the previous generic phrasing.

Possibly related PRs

• Add packages input for selective package testing #9 — Implements the packages input feature for workspace testing that is documented and configured in this PR's action.yml and README updates.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Docs: Improve README documentation for workspace support' directly and clearly summarizes the main change: improving README documentation specifically for workspace support.
Description check	✅ Passed	The description is directly related to the changeset, providing a clear summary of the documentation improvements made to the README and action.yml files.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/improve-readme-workspace-docs

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 0.00%. Comparing base (7e492e1) to head (4280cf3).
⚠️ Report is 2 commits behind head on v1-master.

Additional details and impacted files

@@       Coverage Diff       @@
##   v1-master   #11   +/-   ##
===============================
===============================

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.