Skip to content

docs: refresh root README — SVG banner, badges, updated content - #14

Merged
jzills merged 1 commit into
developfrom
docs/root-readme-refresh
Jul 8, 2026
Merged

jzills merged 1 commit into
developfrom
docs/root-readme-refresh

Conversation

@jzills

@jzills jzills commented Jul 8, 2026

Copy link
Copy Markdown
Owner

Root README refresh

Focused on the root README.md (the detailed src/README.md is already current). Adds a branded header and brings the stale landing copy up to date with the library's current capabilities.

Added

  • resources/banner.svg — a centered ANSI-Shadow block wordmark ("ACTION" over "CACHE") in violet #a371f7, transparent background, monospace. Matches the SVG-wordmark style of the kx / hmac-manager repos. Verified to render cleanly on both light and dark backgrounds.
  • Badge row (unified shields flat-square, dark labelColor): CI, CodeQL, NuGet version, downloads, MIT license, and .NET 8 | 10. Each URL was confirmed to resolve (CI/CodeQL: passing; nuget: v0.0.9; downloads: 1.8k).

Updated

  • Features now cover all four backends (Memory, Redis, SQL Server, Cosmos), MVC + Minimal API support, namespaced eviction, cache refresh, and fail-open resilience.
  • Added a Quickstart (register + cache/evict attributes), verified against the real API (AddActionCache / UseMemoryCache, [ActionCache] / [ActionCacheEviction] with Namespace =).
  • Added a target-frameworks note (.NET 8 / .NET 10).

Verification

  • resources/banner.svg is valid XML and rendered (light + dark) for visual check.
  • All shields badge URLs resolve.
  • LICENSE exists (license badge link is valid); TOC anchors match headings.

🤖 Generated with Claude Code

… content

Adds a centered ANSI-Shadow SVG wordmark (resources/banner.svg) matching the
hmac-manager/kx repo style, and a unified flat-square badge row: CI, CodeQL,
NuGet version, downloads, MIT license, and .NET 8/10.

Refreshes the stale landing copy to reflect current capabilities: all four
backends (Memory, Redis, SQL Server, Cosmos), MVC + Minimal API support,
namespaced eviction, cache refresh, and fail-open resilience. Adds a Quickstart
(register + cache/evict attributes) and target-frameworks note.
@jzills
jzills merged commit 4cb2244 into develop Jul 8, 2026
4 checks 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