Skip to content

docs: update README.adoc with all new features through v0.2.10#14

Merged
ronaldtse merged 1 commit into
mainfrom
docs/update-readadme
May 13, 2026
Merged

docs: update README.adoc with all new features through v0.2.10#14
ronaldtse merged 1 commit into
mainfrom
docs/update-readadme

Conversation

@ronaldtse
Copy link
Copy Markdown
Contributor

Documents all features added across PRs #11, #12, #13 that were missing from the README:

  • 13 new Ruby API sections (content extraction, composite snapshot, parallel CDX, snapshot diff, coverage analysis, health check, content tracking, archive search, WARC support, configuration, encoding detection, path sanitization, color output)
  • 20+ new CLI commands and options
  • Updated architecture table with all 30+ classes
  • Updated purpose statement

The README grew from 631 to 980 lines to cover the full feature set.

Document all features added across PRs #11, #12, #13:
- Page content extraction (headings, images, forms, scripts)
- Composite snapshot, CDX caching, parallel CDX
- Save API response details and rate limiter
- Enhanced bulk download options (page-requisites, snapshot-at,
  all-timestamps, strategy, pattern filtering, subdomain discovery)
- Enhanced URL rewriting (JS, absolute, server extensions)
- Snapshot comparison and diff
- Coverage analysis and archive health check
- Content tracking and archive search
- WARC format support (read/write)
- Configuration, encoding detection, path sanitization
- Pattern filtering, rate limiting, color output
- All new CLI commands and options
- Updated architecture table with all classes
@ronaldtse ronaldtse merged commit ea9c1ba into main May 13, 2026
14 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