Skip to content

Redesign the README for scanning - #3

Merged
hasan-muzak merged 1 commit into
mainfrom
docs/readme-redesign
Nov 12, 2026
Merged

hasan-muzak merged 1 commit into
mainfrom
docs/readme-redesign

Conversation

@hasan-muzak

@hasan-muzak hasan-muzak commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

What changed

Only README.md. The README now follows the shared SDK template: centred logo, tagline, badge row, banner, "What is this", "Getting started" (prerequisites, pip install fingerly, read an event with both clients, verify a webhook, docs link), a "Choose what you need" table and a contents list, then the reference sections, Requirements, Documentation, Help and Licence.

Reorganisation inside the reference material:

  • Proxy status codes are collected into one table (404, 405, 401, 413, 400, 504, 502, 500).
  • The ASGI and WSGI adapter choice is a table; the event_pending and event_not_found codes are a table.
  • The three framework guides (FastAPI, Django, Flask) have a summary table and each complete app is folded into <details>. "A note on mount paths" and "Source structure" are folded too.

Preserved

Every fact from the old README was kept: key rules and rejected key kinds, endpoint override, no redirects, no retries, FingerlyAPIError fields and the three error classes, ip_network, document, has_document, suspect_score and project_id semantics, 30-day retention, the verify-a-backend-action policy text, the webhook rules (raw bytes, 300 second tolerance, rotation, first 32 signatures, never raises, project_id in deliveries), the sync-in-async warning, closing rules, proxy path rules, headers forwarded and relayed, x-fingerly-proxy-version, user agent, 1 MiB and 4 MiB caps, client_ip rules and the 500 message, ProxyRequest fields, mount path notes, all three framework apps, timeouts (10 s and 5 s), the thread sizing arithmetic, connection pooling (256, five minutes), API version, development commands and source structure. All code samples are unchanged except as noted below.

Verified

  • Samples checked against src/fingerly (constructor arguments, events.list parameters, verify_webhook signature, FingerlyProxy and ProxyRequest fields).
  • pytest (261 passed), uv build and the wheel metadata (README is the long description) all pass locally.
  • Links return 200: docs pages (SDK guide, reading events, webhooks, proxy integrations, API keys, API reference overview), PyPI project, workflow page, LICENSE blob, shields.io badges.
  • Badges: PyPI version, CI (ci.yml), minimum Python 3.9 (from requires-python), licence (Apache-2.0 per LICENSE), docs.
  • No em or en dashes, no social links.

Sample fix

The proxy construction sample used os.environ without import os; the import was added.

Notes

  • The logo, dark logo and banner URLs point at fingerly-io/.github assets; they return 200 now.
  • Requirements lists httpx>=0.27,<1 from pyproject.toml.

Adopt the shared SDK README layout: header, badges, getting started, a choose-what-you-need table, proxy status table and folded framework guides. Every fact and sample is kept; the proxy sample gains the missing os import.
@hasan-muzak
hasan-muzak merged commit e6a1577 into main Nov 12, 2026
6 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