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

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, Maven and Gradle install, read an event, 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:

  • The exception classes, the two 404 checks (isPending(), isEventNotFound()) and the proxy status answers (404, 405, 401, 413, 504, 502, 500) are tables.
  • A new adapter table (stack, artifact, class, how it is registered) leads the adapter sections; the Spring Boot 3/4 and reactive Spring configuration classes and the source structure are folded into <details>.
  • "Then point the browser SDK at the same path" moved up next to the proxy builder, ahead of the adapters.

Preserved

Every fact from the old README was kept: the version strings the release script checks (<version>0.2.0</version>, io.fingerly:fingerly-server:0.2.0, java/0.2.0; scripts/check-versions.sh passes), the artifact table, provided scope, jackson-databind, Automatic-Module-Name, key rules (rejected by build()), endpoint(), no redirects, one request and no retry, the request id IllegalArgumentException, getProjectId(), blocking and async reads, deadline handling on the JVM, the 4 MiB limit and gzip/deflate, the two-minute and 20-minute pool replacement rules and httpClient(), the exception hierarchy, redaction, unscored events, getRaw() and the Spring Boot 4 Jackson 3 warning, the pending-read sample, the verify-a-backend-action policy text, the webhook rules (raw bytes, five minutes, 32 signatures, never an exception, getData().path("project_id")), every proxy rule (exact path, WebFlux requirement, clientIp rules and the 500 message, handles(path), headers forwarded and relayed, java/0.2.0, timeout() 5 seconds, System.Logger name), the Spring Security ordering note, the javaxservlet package note, development commands and source structure. A mechanical diff of every inline-code token and number in the old text against the new text reports nothing missing.

Verified

  • Samples checked against the source (FingerlyClient, EventsService, EventListParams, Event, FingerlyApiException, Webhooks, WebhookEvent, FingerlyProxy builder and filters, package names of the three adapter modules).
  • ./gradlew build passes locally on JDK 17; scripts/check-versions.sh passes.
  • Links return 200: docs pages (SDK guide, reading events, webhooks, proxy integrations, API keys, API reference overview), Maven Central page, workflow page, LICENSE blob, shields.io badges (the Maven Central badge renders v0.2.0), brand assets.
  • Badges: Maven Central version, CI (ci.yml), minimum Java 11 (from the --release 11 build setting), licence (Apache-2.0 per LICENSE), docs.
  • No em or en dashes, no social links.

Notes

  • No code sample needed a fix. The Spring webhook sample (ResponseEntity, events.enqueue) is illustrative and unchanged.
  • The Java page on docs.fingerly.io still shows 0.1.0 in its install snippets; this README, like gradle.properties, says 0.2.0.

Adopt the shared SDK README layout: header, badges, getting started, a choose-what-you-need table, status and adapter tables and folded configuration samples. Every fact and sample is kept; the version strings the release check reads are unchanged.
@hasan-muzak
hasan-muzak merged commit e8e1779 into main Nov 12, 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