docs: hero demo GIF in README (EN/RU/UZ) - #14
Merged
Merged
Conversation
Illustrative developer-flow animation — the real identify() call synced to a phone (idle -> tap -> liveness placeholder -> typed success/cancel). Captioned as illustrative; the MyID SDK renders its own native UI on device. Asset in docs/media (not in the npm files allowlist); referenced by absolute raw URL so it renders on GitHub + npm and feeds the reactnative.directory images[].
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
1 participant
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.
Adds a looping hero demo GIF to the top of the README (all three languages), under the tagline.
What it shows: an honest developer-flow animation — the real
identify({ sessionId, clientHash, clientHashId })call on the left, synced to a phone on the right going idle → tap → (abstract, non-MyID) liveness placeholder → typed success (code+comparison) → a typedMyIdErrorcancel. Captioned "Illustrative developer flow — the MyID SDK renders its own native liveness UI on device" so it never misrepresents MyID's proprietary screens (this package is unofficial).Mechanics:
docs/media/myid-demo.gif(900×540, ~1.7 MB, loops). Not added to the npmfilesallowlist — the README references it by an absoluteraw.githubusercontent.com/.../main/...URL, so it renders on GitHub and npm without bloating the tarball, and feeds the reactnative.directoryimages[]on their next data refresh (badges are filtered; a real image is not).Docs-only → native build gates skip; the fast lint/typecheck/build/test job still runs.