docs: correct the README against the code, and tag Revyl links for attribution - #20
Merged
Conversation
The README had drifted behind several merged PRs. - Document `preflight --verify`, which chains the runtime tier onto the static run. It was undocumented even though the CLI advertises it. - Document `--exit-code` on preflight/playscan/verify, and replace the jq hack in the CI section with it. - Add the CRITICAL/HIGH/WARN/INFO ladder. HIGH shipped in #6 and was never written down; the Claude Code section still said "CRITICAL, then WARN, then INFO". - Correct the codescan rule list against the code. It claimed "30+ patterns" and got several severities wrong. It is 24 rules, ~60 patterns, now grouped by the severity each rule actually emits, with the three undocumented rules (webview-only, missing-privacy-keys, console-log) added. - Add the crypto 3.1.5(b) rules from #14. - Document verify's Android support, --artifact upload, --open, and the simulator .app / .apk artifact rules. - Document the inline `// greenlight:ignore` directive. - Fix the output-format section, which claimed every command supports every format. privacy has no --format at all; ipa/playscan/verify are terminal+json; scan has junit. - Add playscan to the architecture tree. - Add the /plugin marketplace install path now that .claude-plugin exists. Editing pass on top of that: 45 em dashes to 0, 34 bold spans to 1.
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.
The README was behind the last several merged PRs, and a few things in it were wrong rather than just missing.
Fixed drift:
preflight --verifywas undocumented. The CLI prints a tip about it on every run.--exit-codewas only documented for playscan. It is on preflight and verify too, and it is the right answer for the CI section, which still used a jq hack.--artifactupload,--open, and the .app / .apk artifact rules were missing.// greenlight:ignoredirective was missing from the config section.--format, ipa/playscan/verify are terminal+json, scan has junit./plugin marketplace addpath now that .claude-plugin ships.Every flag and command in the new README was diffed against
--helpoutput. Every severity claim was diffed against the rule definitions.Editing pass on top: 45 em dashes to 0, 34 bold spans to 1, and the padding trimmed.
Second commit: Revyl attribution + CTA.
Every Revyl link in the README was untagged, so traffic off a 2.3k-star repo landed unattributed. Now tagged with
utm_medium=readmeand a per-placement campaign, following the pattern #13 set for the CLI.verifycatches and discloses the requirement after.verify --dry-run, which is free, needs no account, and works with therevylCLI absent.--verifyCI gating example.--dry-runwas tested with therevylCLI off PATH to confirm the "no account needed" claim. An earlier draft had aREVYL_API_KEYenv var in the CI snippet; greenlight has no such variable (auth is delegated to therevylCLI), so it was removed.