Skip to content

chore: crates.io metadata and README accuracy fixes#12

Merged
27Bslash6 merged 1 commit intomainfrom
chore/crates-metadata
Apr 26, 2026
Merged

chore: crates.io metadata and README accuracy fixes#12
27Bslash6 merged 1 commit intomainfrom
chore/crates-metadata

Conversation

@27Bslash6
Copy link
Copy Markdown
Contributor

@27Bslash6 27Bslash6 commented Apr 26, 2026

Summary

  • Add readme, homepage, keywords, categories to both crate Cargo.tomls
  • Fix encryption docs: ring on native, aes-gcm on wasm32 (via cachekit-core)
  • Update dependency version references from 0.0.1-alpha.1 to 0.2
  • Add Redis backend usage example with explicit connect() call
  • Add cachekit-macros/README.md pointing to main crate docs
  • Improve architecture tree with accurate module descriptions

Test plan

  • cargo publish -p cachekit-macros --dry-run — packages cleanly (7 files, 11.8KB)
  • cargo clippy -- -D warnings — clean
  • All 105 tests passing
  • cargo publish -p cachekit-rs --dry-run — expected failure (cachekit-macros not on crates.io yet; handled by sequential publish in release workflow)

Summary by CodeRabbit

  • Documentation

    • Updated documentation for version 0.2, including revised feature examples and backend capabilities.
    • Enhanced environment variable guidance with security constraints.
    • Added Redis cluster support documentation.
    • Improved encryption and security documentation with cross-SDK compatibility notes.
    • Added new documentation for the cachekit-macros crate with usage examples.
  • Chores

    • Updated package metadata across crates for improved discoverability.

- Add readme, homepage, keywords, categories to both crate Cargo.tomls
- Fix encryption docs: ring on native, aes-gcm on wasm32 (via cachekit-core)
- Update version references from 0.0.1-alpha.1 to 0.2
- Add Redis backend usage example with explicit connect()
- Add cachekit-macros README pointing to main crate docs
- Improve architecture tree with accurate module descriptions
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 26, 2026

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Free

Run ID: a790ba3b-2aa2-479b-821c-96b6d19663db

📥 Commits

Reviewing files that changed from the base of the PR and between 73ea826 and 8fd4791.

📒 Files selected for processing (4)
  • README.md
  • crates/cachekit-macros/Cargo.toml
  • crates/cachekit-macros/README.md
  • crates/cachekit/Cargo.toml

📝 Walkthrough

Walkthrough

The PR updates documentation and metadata across the cachekit-rs project. Root README reflects version 0.2 with updated examples, expanded backend capabilities, Redis cluster support, and strengthened security guidance. New proc-macro README and enhanced Cargo metadata improve project visibility and discoverability.

Changes

Cohort / File(s) Summary
Documentation Updates
README.md, crates/cachekit-macros/README.md
Root README updated to version 0.2 with revised examples, expanded backend capabilities (Redis cluster support), and strengthened environment variable security guidance. New proc-macro README added with usage examples and feature configuration.
Cargo Metadata
crates/cachekit-macros/Cargo.toml, crates/cachekit/Cargo.toml
Extended package metadata with readme, homepage, keywords, and categories fields for improved crate discoverability and documentation linking.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 A hop through the docs, now shiny and bright!
Version 0.2 dances into the light,
Metadata gleams, examples run clear,
Redis clusters and guards standing near,
Our cachekit-rs struts with all of its might! ✨


Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

Comment @coderabbitai help to get the list of available commands and usage tips.

@27Bslash6 27Bslash6 merged commit 61b9e17 into main Apr 26, 2026
5 checks passed
@27Bslash6 27Bslash6 deleted the chore/crates-metadata branch April 26, 2026 01:46
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