Skip to content

[docs] update README#46

Merged
capcom6 merged 1 commit intomasterfrom
codex/update-readme-to-match-library-state
Apr 12, 2026
Merged

[docs] update README#46
capcom6 merged 1 commit intomasterfrom
codex/update-readme-to-match-library-state

Conversation

@capcom6
Copy link
Copy Markdown
Member

@capcom6 capcom6 commented Apr 10, 2026

Motivation

  • The existing README no longer reflected the current package layout and exported client methods.
  • The project documentation was standardized to follow the Best-README-Template for clearer onboarding.

Description

  • Rewrote README.md using a Best-README-Template layout with a centered header, project logo, and collapsible table of contents.
  • Updated the project overview to describe the actual packages (smsgateway, ca, and shared rest) and authentication options (Basic and Bearer).
  • Replaced old usage snippets with current examples showing smsgateway.NewClient(...) and ca.NewClient() usage.
  • Added an explicit API coverage section that matches implemented client methods such as Send, GetState, ListDevices, CheckHealth, GetLogs, GetSettings, RegisterWebhook, GenerateToken, PostCSR, and GetCSRStatus.

Testing

  • Ran go test ./... to validate package integrity.
  • All packages passed: ca, rest, smsgateway, and smsgateway/webhooks reported ok status.

Codex Task

Summary by CodeRabbit

  • Documentation
    • Redesigned README with a new branded layout, centered logo and refreshed Table of Contents
    • Reframed library description to emphasize typed clients and shared HTTP handling, and documented supported authentication modes (Basic, Bearer)
    • Updated usage examples: streamlined SMS example to show immediate request submission and state ID logging; added CSR example showing request status outputs
    • Replaced API Reference with an API Coverage section listing method groups; simplified contributing steps and updated license wording

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 10, 2026

Warning

Rate limit exceeded

@capcom6 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 26 minutes and 0 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 26 minutes and 0 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e38cd0da-5e13-47df-bc63-cbfe4e347ddb

📥 Commits

Reviewing files that changed from the base of the PR and between 4c595bd and 4a621a1.

📒 Files selected for processing (1)
  • README.md

Walkthrough

Rewrote README.md layout: added a centered logo block, updated Table of Contents, consolidated sections into "Getting Started", "Usage", and "API Coverage", updated usage examples for smsgateway.Client and ca.Client, and simplified contributing and license text. (Lines changed: +109 / -69)

Changes

Cohort / File(s) Summary
Documentation
README.md
Complete restructuring of README: new branded layout with centered logo and updated Table of Contents; consolidated sections into Getting Started, Usage, and API Coverage; replaced prior API Reference with method-group API Coverage for smsgateway.Client and ca.Client; updated usage examples (context-based smsgateway.Client.Send, ca.Client.PostCSR); simplified contributing and license text.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title '[docs] update README' is generic and vague; it fails to convey the specific improvement (standardizing documentation structure and matching current API coverage). Consider a more descriptive title such as '[docs] refresh README to match current API coverage' or '[docs] standardize README with Best-README-Template layout' to better communicate the substantive changes.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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.


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 and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 15: The README's <img> tag currently points to a 404 URL in the
android-sms-gateway repo (the src attribute
"https://raw.githubusercontent.com/.../images/icon.png"); fix it by replacing
the src in the <img> tag with a working URL or a local repo path: either verify
and use the correct path in the android-sms-gateway repository, upload/commit
the logo into this repository and point src to that file (e.g., include the
image alongside README and use its relative path), or swap in an alternative
hosted image URL; update only the src value in the <img> tag in README.md.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: f9fa0721-fd33-471f-b3e8-637473536440

📥 Commits

Reviewing files that changed from the base of the PR and between 6e7d60c and 990b0b5.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md Outdated
@capcom6 capcom6 force-pushed the codex/update-readme-to-match-library-state branch from 990b0b5 to f8b9031 Compare April 10, 2026 11:07
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Around line 156-172: Check the source definitions of smsgateway.Client and
ca.Client to confirm each method listed in the README is actually exported;
specifically verify that smsgateway.Client includes Send, GetState, ListDevices,
DeleteDevice, ExportInbox, CheckHealth, GetLogs, GetSettings, UpdateSettings,
ReplaceSettings, ListWebhooks, RegisterWebhook, DeleteWebhook, GenerateToken,
RefreshToken and RevokeToken, and that ca.Client includes PostCSR and
GetCSRStatus; if any are missing, either implement and export corresponding
public methods on the Client types (wrapping the appropriate API endpoints and
returning the documented responses) or remove/adjust the README entries to match
the actual exported APIs so the docs reflect the code.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 8616e384-4670-4f38-8991-00d9c2ad90b1

📥 Commits

Reviewing files that changed from the base of the PR and between f8b9031 and 4c595bd.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md
@capcom6 capcom6 force-pushed the codex/update-readme-to-match-library-state branch from 4c595bd to 4a621a1 Compare April 11, 2026 07:55
@capcom6 capcom6 changed the title docs: refresh README to match current API coverage [docs] update README Apr 11, 2026
@capcom6 capcom6 marked this pull request as ready for review April 11, 2026 09:47
@capcom6 capcom6 merged commit 0e067e8 into master Apr 12, 2026
4 checks passed
@capcom6 capcom6 deleted the codex/update-readme-to-match-library-state branch April 12, 2026 01:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant