Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,15 @@ repos:
files: ^((packages|crates)/[^/]+/)?README[^/]*$|^docs/
types: [text]
stages: [pre-commit]
- id: no-retired-names
name: No retired product names or wrong package names in docs
# The hosted service is "CacheKit Cloud" in prose; `CachekitIO` is only a code identifier.
# Naming rules: https://docs.cachekit.io/contributing/#names
language: pygrep
entry: '(?i:\bCachekitIO[ -](?:Cloud|SaaS|backend|service|server|API)s?\b)|\bSaaS\b|(?i:(?<![\w./-])cachekit\.io (?:backend|service|cloud|server|platform|API|client|account|tenant|dashboard|plan|tier)s?\b)|\bCacheKit ?IO\b|\bCachekit\.IO\b|\bCacheKit\.io\b|\b(?!CacheKit Cloud\b)[Cc]ache[Kk]it [Cc]loud\b|(?<![\w./@`-])Cachekit(?![\w.-])|(?i:Production-ready Redis caching)|(?i:\bno backend required\b)|\bcargo add cachekit(?![\w-])|\b(?:npm (?:i|install)|pnpm (?:add|i|install)|yarn add|bun add) +cachekit(?![\w-])|\bpip install \W?cachekit-py\b'
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Resolved
files: ^((packages|crates)/[^/]+/)?README[^/]*$|^docs/|^llms\.txt$
types: [text]
stages: [pre-commit]
- id: no-internal-references-commit-msg
name: No internal references in commit message
# Same patterns. git hands this hook the raw message file: "# " comment lines, the diff
Expand Down
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,18 +39,15 @@
| `encryption` | AES-256-GCM ([`ring`](https://crates.io/crates/ring) on native, [`aes-gcm`](https://crates.io/crates/aes-gcm) on wasm32) + HKDF-SHA256 ([`hkdf`](https://crates.io/crates/hkdf)) | ❌ |
| `ffi` | C header generation | ❌ |

```toml
# Cargo.toml - defaults only
[dependencies]
cachekit-core = "0.1"
```bash
# Defaults only
cargo add cachekit-core

# With encryption
[dependencies]
cachekit-core = { version = "0.1", features = ["encryption"] }
cargo add cachekit-core --features encryption

# For C FFI development
[dependencies]
cachekit-core = { version = "0.1", features = ["ffi", "encryption"] }
cargo add cachekit-core --features ffi,encryption
```

---
Expand Down
Loading