docs: update the usage description

[driftcell]

We use build-dependencies only when build.rs needs dependencies, for test case, dev-dependencies is correct way.

One more thing is in example code, is use gh_workflows::* outdated? I remove the s then success to run.

Summary by CodeRabbit

• Documentation
  • Fixed dependency specification and import path references in code examples.

[coderabbitai]

Walkthrough

Documentation corrections in README.md updating a Rust code example with corrected dependency section names and import paths.

Changes

Cohort / File(s)	Summary
Documentation corrections README.md	Updated dependency specification from [build-dependencies] to [dev-dependencies] and corrected import path from gh_workflows::* to gh_workflow::* in code example

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A typo hopped away today,
Imports now show the proper way,
Dependencies in their rightful place,
Examples shine with corrected grace!

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The PR title "docs: update the usage description" is directly related to the changeset. The changes consist entirely of documentation updates in README.md, specifically correcting a dependency specification (from build-dependencies to dev-dependencies) and fixing an import path (from gh_workflows::* to gh_workflow::*). Both of these are indeed corrections to the usage/code examples in the documentation. The title appropriately uses the "docs:" prefix convention and clearly indicates the nature of the changes as documentation updates. While the title could be more specific about the exact issues being fixed, it is sufficiently clear and descriptive for a reader scanning project history to understand this is about updating usage examples/documentation.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8ec2428 and c12cd82.

📒 Files selected for processing (1)

• README.md (2 hunks)

🔇 Additional comments (2)

README.md (2)

26-28: Correct dependency section for test code.

Using [dev-dependencies] is the right choice here. Since the example code is a test function, it belongs in [dev-dependencies] rather than [build-dependencies] (which is for build.rs scripts). This is a helpful clarification in the documentation.

---

37-39: Corrected import path to match the actual crate name.

Changed from gh_workflows::* to gh_workflow::* to align with the crate name gh-workflow (published on crates.io in line 6 and specified in line 27). In Rust, hyphens in package names become underscores when used as module paths, so this correction is accurate.

---

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.}