Skip to content

Complete README with examples for all features#14

Merged
enaboapps merged 1 commit intomainfrom
feature/readme-7
Feb 26, 2026
Merged

Complete README with examples for all features#14
enaboapps merged 1 commit intomainfrom
feature/readme-7

Conversation

@enaboapps
Copy link
Copy Markdown
Owner

Summary

  • Expand README from 76 to ~220 lines with examples for all SDK features
  • Add sections: tags, full LogEntry fields, dynamic user/session, flow tracking, raw ingestion, error handling, flush/disconnect, retry config
  • Add complete API reference tables for TimberlogsClient, Flow, and enums
  • Add on_error callback config to the configuration table

Closes #7

Test plan

  • Review examples for accuracy against current API
  • Verify code snippets compile conceptually

Add documentation for tags, full LogEntry fields, dynamic user/session,
flow tracking, raw ingestion, error handling (on_error + direct),
flush/disconnect, retry config, and complete API reference tables.

Closes #7
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Feb 26, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feature/readme-7

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.

@enaboapps enaboapps merged commit 2e129fd into main Feb 26, 2026
1 of 2 checks passed
@enaboapps enaboapps deleted the feature/readme-7 branch February 26, 2026 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants