Skip to content

docs: rewrite README to match what the tool actually does#3

Merged
C-Moir merged 1 commit into
masterfrom
docs/honest-readme
Apr 20, 2026
Merged

docs: rewrite README to match what the tool actually does#3
C-Moir merged 1 commit into
masterfrom
docs/honest-readme

Conversation

@C-Moir
Copy link
Copy Markdown
Owner

@C-Moir C-Moir commented Apr 20, 2026

The previous README claimed "live feed of new deployments" across 12 platforms. Reality after the recent fixes:

  • CT logs are cert lifecycle events, not deployment events. Most LE traffic is 90-day renewals, not fresh deployments. Now that novelty.js classifies new vs renewal, describe it accurately.
  • 4 of the 12 platforms (Vercel, Netlify, Glitch, Surge) use wildcard certs and can't be tracked without per-user API tokens. Split the platform list into 'tracked' and 'not tracked' so readers know what to expect.
  • URLScan is no longer called on every clean site — it's escalation-only. Document that under configuration and limitations.
  • AbuseIPDB auto-reporting is disabled in code; the README should say so.
  • Low-volume platforms (Fly.io, Deno, Railway) will look sparse. Set expectations in 'Known limitations'.

Keeps the install / routes / content tags sections, which are still accurate. Drops the hype language.

The previous README claimed "live feed of new deployments" across 12
platforms. Reality after the recent fixes:

- CT logs are cert lifecycle events, not deployment events. Most LE traffic
  is 90-day renewals, not fresh deployments. Now that novelty.js classifies
  new vs renewal, describe it accurately.
- 4 of the 12 platforms (Vercel, Netlify, Glitch, Surge) use wildcard certs
  and can't be tracked without per-user API tokens. Split the platform list
  into 'tracked' and 'not tracked' so readers know what to expect.
- URLScan is no longer called on every clean site — it's escalation-only.
  Document that under configuration and limitations.
- AbuseIPDB auto-reporting is disabled in code; the README should say so.
- Low-volume platforms (Fly.io, Deno, Railway) will look sparse. Set
  expectations in 'Known limitations'.

Keeps the install / routes / content tags sections, which are still
accurate. Drops the hype language.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@C-Moir C-Moir merged commit 7d46b10 into master Apr 20, 2026
1 check 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