Repository navigation
Redesign the README for scanning - #3
Merged
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
404checks (isPending(),isEventNotFound()) and the proxy status answers (404, 405, 401, 413, 504, 502, 500) are tables.<details>.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.shpasses), the artifact table,providedscope,jackson-databind,Automatic-Module-Name, key rules (rejected bybuild()),endpoint(), no redirects, one request and no retry, the request idIllegalArgumentException,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 andhttpClient(), 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 (exactpath, WebFlux requirement,clientIprules and the500message,handles(path), headers forwarded and relayed,java/0.2.0,timeout()5 seconds,System.Loggername), the Spring Security ordering note, thejavaxservletpackage 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
FingerlyClient,EventsService,EventListParams,Event,FingerlyApiException,Webhooks,WebhookEvent,FingerlyProxybuilder and filters, package names of the three adapter modules)../gradlew buildpasses locally on JDK 17;scripts/check-versions.shpasses.ci.yml), minimum Java 11 (from the--release 11build setting), licence (Apache-2.0 perLICENSE), docs.Notes
ResponseEntity,events.enqueue) is illustrative and unchanged.0.1.0in its install snippets; this README, likegradle.properties, says0.2.0.