Skip to content

docs: rewrite README - #46

Merged
kasparsd merged 1 commit into
masterfrom
docs/readme-rewrite
Oct 30, 2026
Merged

kasparsd merged 1 commit into
masterfrom
docs/readme-rewrite

Conversation

@kasparsd

Copy link
Copy Markdown
Collaborator

Summary

  • Rewrites README.md: removes sections that had accumulated over time, adds a table of contents, and states up front how the module differs from ngx_cache_purge.
  • Explains what a distro nginx ABI is and how Vary turns one cache key into several cache files.
  • Removes a stale note claiming the trailing purge argument is stored as a literal string. ngx_http_cache_pilot_conf compiles every condition as a complex value.
  • Replaces em dashes with colons.

Checked against the source

  • purge_path values, index not_ready_reason values, the 1000-token tag scan limit, and the directive list all match src/.
  • The Ubuntu 22.04 unsupported note and the PPA series (noble, resolute) match the latest release-workflow commits.

Not verified

  • I did not build or run anything; this is documentation only.
  • The nginx 1.21.4 minimum is carried over from the old README, not re-derived.

🤖 Generated with Claude Code

Deduplicate accumulated sections, add a table of contents, explain the
distro nginx ABI and how Vary produces several cache files per key, and
compare against ngx_cache_purge up front. Drop a stale note about a
literal purge method token; all conditions compile as complex values.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
NGINX Valid Scenario GET rps p50 p95 p99 Hit% Purges IdxPlan IdxSeen
1.26.3 ✅ valid exact_baseline_purge 4201.1 9.9ms 21.6ms 27.4ms 99.8% 150 off off
1.26.3 ✅ valid tag_shm_purge 4226.9 9.9ms 21.0ms 26.1ms 100.0% 75 ready cfg
1.26.3 ✅ valid exact_scan_purge 4138.7 9.9ms 22.0ms 27.2ms 99.8% 150 off off
1.26.3 ✅ valid exact_indexed_purge 3698.1 11.1ms 24.0ms 30.3ms 99.8% 150 fanout assist
1.26.3 ✅ valid wildcard_scan_purge 3962.5 10.1ms 24.8ms 33.0ms 96.1% 30 off off
1.26.3 ✅ valid wildcard_indexed_purge 3999.8 10.0ms 24.7ms 33.4ms 96.0% 30 w-prefix assist
NGINX Valid Scenario GET rps p50 p95 p99 Hit% Purges IdxPlan IdxSeen
1.28.3 ✅ valid exact_baseline_purge 4839.1 8.5ms 19.5ms 23.8ms 99.8% 150 off off
1.28.3 ✅ valid tag_shm_purge 4892.8 8.4ms 19.4ms 24.0ms 100.0% 75 ready cfg
1.28.3 ✅ valid exact_scan_purge 5025.7 8.2ms 18.8ms 23.1ms 99.8% 150 off off
1.28.3 ✅ valid exact_indexed_purge 4474.8 9.2ms 20.8ms 25.8ms 99.8% 150 fanout assist
1.28.3 ✅ valid wildcard_scan_purge 4488.8 8.9ms 22.8ms 30.1ms 96.5% 30 off off
1.28.3 ✅ valid wildcard_indexed_purge 4486.1 8.9ms 22.7ms 30.9ms 96.5% 30 w-prefix assist
NGINX Valid Scenario GET rps p50 p95 p99 Hit% Purges IdxPlan IdxSeen
1.29.8 ✅ valid exact_baseline_purge 3522.8 11.5ms 25.9ms 32.2ms 99.8% 150 off off
1.29.8 ✅ valid tag_shm_purge 3471.3 11.7ms 26.2ms 31.8ms 100.0% 75 ready cfg
1.29.8 ✅ valid exact_scan_purge 3625.5 11.1ms 25.0ms 30.6ms 99.8% 150 off off
1.29.8 ✅ valid exact_indexed_purge 3368.2 12.2ms 26.0ms 32.7ms 99.8% 150 fanout assist
1.29.8 ✅ valid wildcard_scan_purge 3533.3 11.3ms 27.9ms 37.7ms 95.7% 30 off off
1.29.8 ✅ valid wildcard_indexed_purge 3741.0 10.6ms 26.8ms 36.3ms 95.9% 30 w-prefix assist

@kasparsd
kasparsd merged commit 62303fe into master Oct 30, 2026
8 checks passed
@kasparsd
kasparsd deleted the docs/readme-rewrite branch October 30, 2026 13:24
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