Improve README usage documentation and examples

[teesofttech]

Summary

• Rewrite README as a practical developer guide for installation, configuration, DI, endpoint usage, errors, tests, and releases
• Add copy-pasteable examples for messaging, sender IDs, Number API, Tokens/OTP, Insights, and error handling
• Update the examples project to use explicit live example actions for balance and Number API sends
• Refresh API coverage status after Insights and v0.2.0 release completion

Validation

• dotnet restore Termii.SDK.sln
• dotnet build Termii.SDK.sln --configuration Release --no-restore
• dotnet test tests/Termii.Tests/Termii.Tests.csproj --configuration Release --no-build --logger "trx;LogFileName=unit-tests.trx"
• dotnet test tests/Termii.IntegrationTests/Termii.IntegrationTests.csproj --configuration Release --no-build --logger "trx;LogFileName=integration-tests.trx"
• dotnet pack src/Termii/Termii.csproj --configuration Release --no-build --output artifacts/packages -p:UseSharedCompilation=false -p:BuildInParallel=false -p:MSBuildNodeReuse=false

Closes #12

Summary by CodeRabbit

• Documentation

  • Completely revised README with detailed installation, client configuration, dependency injection setup, and expanded usage examples for SMS, Number API, and Insights endpoints.
  • Updated API coverage matrix to reflect implementation status and v0.2.0 release milestones.
  • Added comprehensive error handling guidance and supported/deferred APIs reference.

• Examples

  • Enhanced example application with new balance and messaging demonstrations using improved environment variable configuration.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a5bf1eb0-b420-449f-a396-bd848a65b837

📥 Commits

Reviewing files that changed from the base of the PR and between 654d4ee and d563aae.

📒 Files selected for processing (3)

• README.md
• docs/API_COVERAGE.md
• examples/Termii.Examples/Program.cs

---

📝 Walkthrough

Walkthrough

This PR fulfills the SDK documentation requirements from issue #12 by expanding the README from a roadmap outline into a practical, example-driven usage guide covering installation, configuration, API patterns, error handling, and supported endpoints. The example application is updated to support environment-variable-driven action selection for live balance and SMS sending demonstrations. API coverage tracking is updated to reflect completed Insights endpoints and the v0.2.0 release.

Changes

Documentation and Examples Update

Layer / File(s)	Summary
README installation and configuration guide README.md	Installation via package manager, manual client creation with override options for base URL and timeout, ASP.NET Core dependency injection setup using AddTermii.
README service integration and messaging examples README.md	NotificationService pattern showing dependency-injected TermiiClient usage. Single SMS via SendSingleMessageAsync and bulk SMS via SendBulkMessageAsync. Number API example using Numbers.SendAsync.
README Tokens, Insights, error handling, and API coverage documentation README.md	OTP verification and generation examples with supported delivery methods. Insights operations for balance, DND status, number intelligence, and message history. TermiiApiException and validation exception patterns. Supported vs. Deferred APIs reference.
README live examples and release information README.md	Live examples configured via TERMII_EXAMPLE_ACTION environment variable (balance and number-message actions with phone number input). Added Release section (v0.2.0) and Links section (developer docs, NuGet, API coverage tracking).
Example application action-based runner examples/Termii.Examples/Program.cs	Entry point refactored to read TERMII_EXAMPLE_ACTION and route execution: balance action calls GetBalanceAsync and prints balance; number-message action validates phone number and sends SMS via Numbers.SendAsync. Removed prior TERMII_SEND_NUMBER_MESSAGE boolean gating.
API coverage tracking updates docs/API_COVERAGE.md	Foundation items: README examples moved to In progress; First GitHub Release/NuGet marked Implemented (v0.2.0, PR #28). Insights endpoints (balance, DND, intelligence, inbox) moved from In progress to Implemented with unit test tracking retained.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

• teesofttech/Termii.SDK#17: Client configuration, HTTP pipeline, and DI registration implementation that these README and example updates document and demonstrate.

Poem

🐰 Hop through the docs with clarity bright,
Install, configure, examples in sight,
Balance and messages, all working so well,
The guide that developers love to tell! ✨

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feature/12-readme-developer-experience

---

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

[Copilot]

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.