Skip to content

Add comprehensive usage documentation to README - #5

Merged
kacy merged 1 commit into
masterfrom
docs/usage-examples
Jan 29, 2026
Merged

Add comprehensive usage documentation to README#5
kacy merged 1 commit into
masterfrom
docs/usage-examples

Conversation

@kacy

@kacy kacy commented Jan 29, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds detailed usage examples for client initialization, authentication, and database operations
  • Documents all available filter methods with their PostgREST equivalents
  • Provides complete code examples that users can copy and adapt

Changes

  • Client initialization (environment variables and explicit configuration)
  • Authentication examples (signup, signin, token refresh, JWT validation)
  • Database CRUD operations with the fluent query builder
  • Filter methods reference table
  • Query modifiers documentation
  • Complex query example combining multiple filters

- Add client initialization examples (env vars and explicit config)
- Add authentication usage examples (signup, signin, refresh, JWT validation)
- Add database operations examples (select, insert, update, delete)
- Document all available filter methods with PostgREST equivalents
- Document query modifiers (order, limit, offset)
- Add example of combining multiple filters

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@kacy
kacy merged commit 9a13d0a into master Jan 29, 2026
1 check passed
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.

1 participant