Skip to content

docs: fix package name in README - #30

Merged
Atharva0506 merged 1 commit into
AOSSIE-Org:mainfrom
Atharva0506:fix/readme-package-name
Aug 7, 2026
Merged

docs: fix package name in README#30
Atharva0506 merged 1 commit into
AOSSIE-Org:mainfrom
Atharva0506:fix/readme-package-name

Conversation

@Atharva0506

@Atharva0506 Atharva0506 commented Aug 7, 2026

Copy link
Copy Markdown
Member

Addressed Issues:

Fixes #29

Screenshots/Recordings:

N/A

Additional Notes:

Updated the README.md to use the correct published package name @aossie-org/thrubox-client instead of @aossie/thrubox-client. This resolves the 404 error during installation, ensuring that new users can follow the getting-started guide seamlessly.

The changes apply to:

  1. The install command
  2. The Quick Start import
  3. The error handling example

Checklist

  • My code follows the project's code style and conventions
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings or errors
  • I have joined the Discord server and I will share a link to this PR with the project maintainers there
  • I have read the Contributing Guidelines

Summary by CodeRabbit

  • Documentation
    • Updated installation, quick-start, and error-handling examples to use the current package reference.

@github-actions github-actions Bot added documentation Changes to documentation files size/XS Extra small PR (≤10 lines changed) repeat-contributor PR from an external contributor who already had PRs merged needs-review labels Aug 7, 2026
@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor
Messages
📖 ### ⚠️ PR Template Check

These are non-blocking, but please fix:

  • Some required checklist items are not completed:
  • My PR addresses a single issue

Generated by 🚫 dangerJS against 5b23f2e

@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 269a9731-b298-4b3e-81ba-b6d4bb0ffacb

📥 Commits

Reviewing files that changed from the base of the PR and between 76e529e and 5b23f2e.

📒 Files selected for processing (1)
  • README.md
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • AOSSIE-Org/ThruBox-Server (manual)

Walkthrough

The README now uses @aossie-org/thrubox-client in the installation, Quick Start, and error-handling examples.

Changes

README package reference

Layer / File(s) Summary
Update README package examples
README.md
Installation and import examples now reference @aossie-org/thrubox-client.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested labels: Documentation

Poem

I’m a rabbit with a README tune,
Hopping past old names beneath the moon.
The package path is fresh and bright,
Quick Start now points to the right.
Three little fixes, then off I flee—
Clean docs for all to see!

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the README package-name correction, which is the main change.
Linked Issues check ✅ Passed The README updates all three required package references to @aossie-org/thrubox-client, satisfying issue #29.
Out of Scope Changes check ✅ Passed The changes are limited to the README package-name corrections required by issue #29.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands.

@Atharva0506
Atharva0506 merged commit 4f56b54 into AOSSIE-Org:main Aug 7, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Changes to documentation files needs-review repeat-contributor PR from an external contributor who already had PRs merged size/XS Extra small PR (≤10 lines changed)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The README tells users to install @aossie/thrubox-client:

1 participant