feat: update library READMEs and add working examples#39
Merged
joshrotenberg merged 2 commits intomainfrom Aug 28, 2025
Merged
Conversation
- Add examples/ directories to both redis-cloud and redis-enterprise crates - Create basic.rs and database_management.rs examples for each library - Update README files with current API patterns using handlers - Show proper usage of CloudDatabaseHandler and BdbHandler - Demonstrate both raw API calls and typed handler methods - Fix compilation errors and use correct builder patterns - Add comprehensive usage examples with environment variable configuration Resolves #35
- Remove duplicate .mdbook-lint.toml from root (keep only in docs/) - Remove mdbook-lint preprocessor from book.toml - Will re-enable after upstream fixes per issue #37
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR addresses issue #35 by updating both library READMEs and adding comprehensive working examples to improve developer experience.
Changes Made
📁 New Examples Added
redis-cloud crate: Added
examples/directory with:basic.rs- Basic connection and account information retrievaldatabase_management.rs- Database operations with proper handler usageredis-enterprise crate: Added
examples/directory with:basic.rs- Cluster info, nodes, and database listingdatabase_management.rs- Database operations with statistics📚 README Updates
CloudDatabaseHandlerBdbHandler🔧 API Pattern Improvements
create()) and raw methods (create_raw())🏗️ Developer Experience Improvements
Key Technical Insights Addressed
CloudDatabaseHandler::new(client)pattern with both typed and raw API methodsBdbHandler::new(client)pattern with fully typed responsesbase_url()Testing
cargo checkcargo fmtandcargo clippychecksThis significantly improves the developer onboarding experience for both Redis Cloud and Enterprise API clients.
Closes #35